diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b2c0c8f7..2e047c35 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,17 +1,19 @@ name: CI on: push: - branches: - - main - pull_request: - branches: - - main - - next + branches-ignore: + - 'generated' + - 'codegen/**' + - 'integrated/**' + - 'stl-preview-head/**' + - 'stl-preview-base/**' jobs: lint: + timeout-minutes: 10 name: lint - runs-on: ubuntu-latest + runs-on: ${{ github.repository == 'stainless-sdks/orb-ruby' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} + steps: - uses: actions/checkout@v4 - name: Set up Ruby @@ -25,8 +27,9 @@ jobs: - name: Run lints run: ./scripts/lint test: + timeout-minutes: 10 name: test - runs-on: ubuntu-latest + runs-on: ${{ github.repository == 'stainless-sdks/orb-ruby' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} steps: - uses: actions/checkout@v4 - name: Set up Ruby diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 10f30916..6b7b74c5 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.2.0" + ".": "0.3.0" } \ No newline at end of file diff --git a/.yardopts b/.yardopts index 004c697b..84c12f2a 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 29068b4c..08770d36 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,39 @@ # Changelog +## 0.3.0 (2025-04-25) + +Full Changelog: [v0.2.0...v0.3.0](https://github.com/orbcorp/orb-ruby/compare/v0.2.0...v0.3.0) + +### Features + +* implement `#hash` for data containers ([ba49d29](https://github.com/orbcorp/orb-ruby/commit/ba49d294bfa09eca64b9a137c730c452318a56d4)) +* support specifying content-type with FilePart class ([200103f](https://github.com/orbcorp/orb-ruby/commit/200103fddf8b1d524caa1cb3a126d72b476315f4)) +* support webmock for testing ([ca1c497](https://github.com/orbcorp/orb-ruby/commit/ca1c497d57309c0bd2518070a0f8af3e0c639be4)) + + +### Bug Fixes + +* ensure gem release is unaffected by renaming ([3e0fd9e](https://github.com/orbcorp/orb-ruby/commit/3e0fd9e21bb02529c0513b7a1e2fbdfa7d80b049)) +* make a typo for `FilePart.content` ([f62d185](https://github.com/orbcorp/orb-ruby/commit/f62d18544ccd90a55bdfc520cbea03c1ea7583d1)) + + +### Chores + +* broadly detect json family of content-type headers ([d4e5904](https://github.com/orbcorp/orb-ruby/commit/d4e5904287b32db4efe997b617310670961be6b1)) +* **ci:** add timeout thresholds for CI jobs ([450f552](https://github.com/orbcorp/orb-ruby/commit/450f552e892e75242d3ec3e3e0c98605e1ac0b61)) +* **ci:** only use depot for staging repos ([fd387ce](https://github.com/orbcorp/orb-ruby/commit/fd387ce6f9dff526039887480712e8b0c35595b5)) +* **ci:** run on more branches and use depot runners ([7f5a6c3](https://github.com/orbcorp/orb-ruby/commit/7f5a6c320853a23d5ac339ea368d7cad7bbc35c5)) +* documentation improvements ([6e04e50](https://github.com/orbcorp/orb-ruby/commit/6e04e5062b468fdf1f40fe3cd491b9fbb610bc5c)) +* explicitly mark apis public under `Internal` module ([d19524a](https://github.com/orbcorp/orb-ruby/commit/d19524a2a412b98ac4529b46c02e249e8a587c34)) +* **internal:** improve response envelope unwrap functionality ([b3f0632](https://github.com/orbcorp/orb-ruby/commit/b3f0632eae23d838395933fe4a334fd23dff46fd)) +* **internal:** minor type annotation improvements ([cf871bc](https://github.com/orbcorp/orb-ruby/commit/cf871bca5feacf6e95351418a3553c774889ccee)) +* **internal:** version bump ([6b83db6](https://github.com/orbcorp/orb-ruby/commit/6b83db65c3d405b7f7c5e20a93be6428dcf7fc08)) +* make sorbet enums easier to read ([3793346](https://github.com/orbcorp/orb-ruby/commit/3793346c4a6cd6ff18aad64e4c48933a5159ebe1)) +* show truncated parameter docs in yard ([0fb86bd](https://github.com/orbcorp/orb-ruby/commit/0fb86bd1313bb300e565f873e5a181f652ce88fa)) +* simplify yard annotations by removing most `@!parse` directives ([a94843b](https://github.com/orbcorp/orb-ruby/commit/a94843be3f13ed22ae07ded47bff22e044525f0b)) +* update README with recommended editor plugins ([50771fd](https://github.com/orbcorp/orb-ruby/commit/50771fdf28dcee2856522c5c29a491873ec14a4a)) +* use `@!method` instead of `@!parse` for virtual method type definitions ([21cfdfc](https://github.com/orbcorp/orb-ruby/commit/21cfdfcc91f9dbd04831e502b990f9118f4b5eb0)) + ## 0.2.0 (2025-04-17) Full Changelog: [v0.1.3...v0.2.0](https://github.com/orbcorp/orb-ruby/compare/v0.1.3...v0.2.0) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2058a521..1dcdaf76 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,20 +96,17 @@ $ bundle exec rake format ## Editor Support -### Solargraph +### Ruby LSP -This library includes [Solargraph](https://solargraph.org) support for both auto-completion and go to definition. +[Ruby LSP](https://github.com/Shopify/ruby-lsp) has quite good support for go to definition, but not auto-completion. -```ruby -gem "solargraph", group: :development -``` +This can be installed along side Solargraph. + +### Solargraph -Note: if you had installed the gem locally using `git: "..."` or `path: "..."`, you must update your [`.solargraph.yml`](https://solargraph.org/guides/configuration) to include the path to where the gem is located: +[Solargraph](https://solargraph.org) has quite good support for auto-completion, but not go to definition. -```yaml -include: - - '/lib/**/*.rb' -``` +This can be installed along side Ruby LSP. ### Sorbet @@ -119,10 +116,6 @@ include: 2. For each generic type in `*.rbi` files, a spurious "Duplicate type member" error is present. -### Ruby LSP - -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. - ## Documentation Preview To preview the documentation, run: diff --git a/Gemfile b/Gemfile index e5ec01e9..0d76364b 100644 --- a/Gemfile +++ b/Gemfile @@ -23,6 +23,7 @@ group :development, :test do gem "minitest-hooks" gem "minitest-proveit" gem "minitest-rg" + gem "webmock" end group :development, :docs do diff --git a/Gemfile.lock b/Gemfile.lock index 1dd82a82..5eebd59e 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - orb-billing (0.1.3) + orb-billing (0.2.0) connection_pool GEM @@ -29,6 +29,8 @@ GEM minitest (>= 5.1) securerandom (>= 0.3) tzinfo (~> 2.0, >= 2.0.5) + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) ast (2.4.3) async (2.23.1) console (~> 1.29) @@ -45,6 +47,9 @@ GEM fiber-annotation fiber-local (~> 1.1) json + crack (1.0.0) + bigdecimal + rexml csv (3.3.3) drb (2.2.1) erubi (1.13.1) @@ -54,6 +59,7 @@ GEM fiber-storage fiber-storage (1.0.0) fileutils (1.7.3) + hashdiff (1.1.2) i18n (1.14.7) concurrent-ruby (~> 1.0) io-event (1.10.0) @@ -82,6 +88,7 @@ GEM racc prettier_print (1.2.1) prism (1.4.0) + public_suffix (6.0.1) racc (1.8.1) rainbow (3.1.1) rake (13.2.1) @@ -96,6 +103,7 @@ GEM logger redcarpet (3.6.1) regexp_parser (2.10.0) + rexml (3.4.1) rubocop (1.75.1) json (~> 2.3) language_server-protocol (~> 3.17.0.2) @@ -165,6 +173,10 @@ GEM unicode-emoji (~> 4.0, >= 4.0.4) unicode-emoji (4.0.4) uri (1.0.3) + webmock (3.25.1) + addressable (>= 2.8.0) + crack (>= 0.3.2) + hashdiff (>= 0.4.0, < 2.0.0) webrick (1.9.1) yard (0.9.37) yard-sorbet (0.9.0) @@ -191,6 +203,7 @@ DEPENDENCIES syntax_tree syntax_tree-rbs! tapioca + webmock webrick yard diff --git a/README.md b/README.md index 27555d12..7af10ad2 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 "orb-billing", "~> 0.2.0" +gem "orb-billing", "~> 0.3.0" ``` @@ -35,6 +35,16 @@ customer = orb.customers.create(email: "example-customer@withorb.com", name: "My puts(customer.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 +orb.customers.create(email: "example-customer@withorb.com", name: "My Customer") +``` + ### Pagination List methods in the Orb API are paginated. @@ -126,61 +136,33 @@ orb.customers.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 -``` - -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. - -```yaml -include: - - 'vendor/bundle/ruby/*/gems/orb-billing-*/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`. +## Model DSL -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. +This library uses a simple DSL to represent request parameters and response shapes in `lib/orb/models`. -Due to limitations with the Sorbet type system, where a method otherwise can take an instance of `Orb::BaseModel` class, you will need to use the `**` splat operator to pass the arguments: +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. -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 = Orb::Models::CustomerCreateParams.new(email: "example-customer@withorb.com", name: "My Customer") -orb.customers.create(**params) +# This also works +params = { + email: "example-customer@withorb.com", + name: "My Customer" +} ``` -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. @@ -191,15 +173,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 `Orb::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. @@ -209,6 +191,30 @@ Unless otherwise specified, other classes in the SDK do not have locks protectin Currently, `Orb::Client` instances are only fork-safe if there are no in-flight HTTP requests. +### Sorbet + +#### Enums + +Sorbet's typed enums require sub-classing of the [`T::Enum` class](https://sorbet.org/docs/tenum) from the `sorbet-runtime` gem. + +Since this library does not depend on `sorbet-runtime`, it uses a [`T.all` intersection type](https://sorbet.org/docs/intersection-types) with a ruby primitive type to construct a "tagged alias" instead. + +```ruby +module Orb::Models::BillingCycleRelativeDate + # This alias aids language service driven navigation. + TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::BillingCycleRelativeDate) } +end +``` + +#### 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 = Orb::Models::CustomerCreateParams.new(email: "example-customer@withorb.com", name: "My Customer") +orb.customers.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. @@ -218,3 +224,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/orbcorp/orb-ruby/tree/main/CONTRIBUTING.md). diff --git a/Rakefile b/Rakefile index 433bf6f4..2e5368f2 100644 --- a/Rakefile +++ b/Rakefile @@ -21,7 +21,7 @@ end desc("Preview docs; use `PORT=` to change the port") multitask(:"docs:preview") do - sh(*%w[yard server --bind [::] --reload --quiet --port], ENV.fetch("PORT", "8808")) + 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") @@ -31,7 +31,7 @@ multitask(:test) do .map { "require_relative(#{_1.dump});" } .join - ruby(*%w[-w -e], rb, verbose: false) { fail unless _1 } + ruby(*%w[-e], rb, verbose: false) { fail unless _1 } end rubo_find = %w[find ./lib ./test ./rbi -type f -and ( -name *.rb -or -name *.rbi ) -print0] @@ -111,7 +111,7 @@ end desc("Typecheck everything") multitask(typecheck: [:"typecheck:steep", :"typecheck:sorbet"]) -desc("Lint everything") +desc("Lint and typecheck") multitask(lint: [:"lint:rubocop", :typecheck]) desc("Build yard docs") @@ -135,5 +135,5 @@ end desc("Release ruby gem") multitask(release: [:"build:gem"]) do - sh(*%w[gem push], *FileList["orb-*.gem"]) + sh(*%w[gem push], *FileList["*.gem"]) end diff --git a/Steepfile b/Steepfile index 6e5d0ac5..d7aebca1 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/lib/orb.rb b/lib/orb.rb index 3afbdb95..489cb88e 100644 --- a/lib/orb.rb +++ b/lib/orb.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 "orb" 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 @@ -40,7 +31,7 @@ require_relative "orb/internal/type/converter" require_relative "orb/internal/type/unknown" require_relative "orb/internal/type/boolean" -require_relative "orb/internal/type/io_like" +require_relative "orb/internal/type/file_input" require_relative "orb/internal/type/enum" require_relative "orb/internal/type/union" require_relative "orb/internal/type/array_of" @@ -50,6 +41,7 @@ require_relative "orb/internal/type/request_parameters" require_relative "orb/internal" require_relative "orb/request_options" +require_relative "orb/file_part" require_relative "orb/errors" require_relative "orb/internal/transport/base_client" require_relative "orb/internal/transport/pooled_net_requester" diff --git a/lib/orb/client.rb b/lib/orb/client.rb index 7c9504dc..4ae96ecd 100644 --- a/lib/orb/client.rb +++ b/lib/orb/client.rb @@ -91,10 +91,10 @@ class Client < Orb::Internal::Transport::BaseClient def initialize( api_key: ENV["ORB_API_KEY"], base_url: ENV["ORB_BASE_URL"], - 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: Orb::Client::DEFAULT_MAX_RETRIES, + timeout: Orb::Client::DEFAULT_TIMEOUT_IN_SECONDS, + initial_retry_delay: Orb::Client::DEFAULT_INITIAL_RETRY_DELAY, + max_retry_delay: Orb::Client::DEFAULT_MAX_RETRY_DELAY, idempotency_header: "Idempotency-Key" ) base_url ||= "https://api.withorb.com/v1" diff --git a/lib/orb/file_part.rb b/lib/orb/file_part.rb new file mode 100644 index 00000000..85188b38 --- /dev/null +++ b/lib/orb/file_part.rb @@ -0,0 +1,55 @@ +# frozen_string_literal: true + +module Orb + class FilePart + # @return [Pathname, StringIO, IO, String] + attr_reader :content + + # @return [String, nil] + attr_reader :content_type + + # @return [String, nil] + attr_reader :filename + + # @api private + # + # @return [String] + private def read + case content + in Pathname + content.read(binmode: true) + in StringIO + content.string + in IO + content.read + in String + content + end + end + + # @param a [Object] + # + # @return [String] + def to_json(*a) = read.to_json(*a) + + # @param a [Object] + # + # @return [String] + def to_yaml(*a) = read.to_yaml(*a) + + # @param content [Pathname, StringIO, IO, String] + # @param filename [String, nil] + # @param content_type [String, nil] + def initialize(content, filename: nil, content_type: nil) + @content = content + @filename = + case content + in Pathname + filename.nil? ? content.basename.to_path : File.basename(filename) + else + filename.nil? ? nil : File.basename(filename) + end + @content_type = content_type + end + end +end diff --git a/lib/orb/internal.rb b/lib/orb/internal.rb index b67eff4e..440a6737 100644 --- a/lib/orb/internal.rb +++ b/lib/orb/internal.rb @@ -1,7 +1,6 @@ # frozen_string_literal: true module Orb - # @api private module Internal OMIT = Object.new.tap do diff --git a/lib/orb/internal/page.rb b/lib/orb/internal/page.rb index d57a2ad9..9034c106 100644 --- a/lib/orb/internal/page.rb +++ b/lib/orb/internal/page.rb @@ -28,7 +28,7 @@ def next_page? end # @raise [Orb::HTTP::Error] - # @return [Orb::Internal::Page] + # @return [self] def next_page unless next_page? message = "No more pages available. Please check #next_page? before calling ##{__method__}" @@ -101,13 +101,9 @@ class PaginationMetadata < Orb::Internal::Type::BaseModel # @return [String, nil] required :next_cursor, String, nil?: true - # @!parse - # # @param has_more [Boolean] - # # @param next_cursor [String, nil] - # # - # def initialize(has_more:, next_cursor:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(has_more:, next_cursor:) + # @param has_more [Boolean] + # @param next_cursor [String, nil] end end end diff --git a/lib/orb/internal/transport/base_client.rb b/lib/orb/internal/transport/base_client.rb index 400340c5..02bf5643 100644 --- a/lib/orb/internal/transport/base_client.rb +++ b/lib/orb/internal/transport/base_client.rb @@ -153,7 +153,7 @@ def reap_connection!(status, stream:) # @api private # @return [Orb::Internal::Transport::PooledNetRequester] - attr_accessor :requester + attr_reader :requester # @api private # @@ -214,11 +214,11 @@ def initialize( # # @option req [Object, nil] :body # - # @option req [Symbol, nil] :unwrap + # @option req [Symbol, Integer, Array, Proc, nil] :unwrap # - # @option req [Class, nil] :page + # @option req [Class, nil] :page # - # @option req [Class, nil] :stream + # @option req [Class, nil] :stream # # @option req [Orb::Internal::Type::Converter, Class, nil] :model # @@ -415,11 +415,11 @@ def initialize( # # @param body [Object, nil] # - # @param unwrap [Symbol, nil] + # @param unwrap [Symbol, Integer, Array, Proc, nil] # - # @param page [Class, nil] + # @param page [Class, nil] # - # @param stream [Class, nil] + # @param stream [Class, nil] # # @param model [Orb::Internal::Type::Converter, Class, nil] # diff --git a/lib/orb/internal/transport/pooled_net_requester.rb b/lib/orb/internal/transport/pooled_net_requester.rb index d9e8ee83..571c9c07 100644 --- a/lib/orb/internal/transport/pooled_net_requester.rb +++ b/lib/orb/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 } @@ -176,7 +176,7 @@ def execute(request) conn.finish if !eof && conn&.started? closing&.call end - [Integer(response.code), response, (response.body = body)] + [Integer(response.code), response, body] end # @api private diff --git a/lib/orb/internal/type/array_of.rb b/lib/orb/internal/type/array_of.rb index d7dc22bd..fa300551 100644 --- a/lib/orb/internal/type/array_of.rb +++ b/lib/orb/internal/type/array_of.rb @@ -28,13 +28,19 @@ class ArrayOf # @option spec [Proc] :union # # @option spec [Boolean] :"nil?" + # + # @return [Orb::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/orb/internal/type/base_model.rb b/lib/orb/internal/type/base_model.rb index eb73b89c..28d47f09 100644 --- a/lib/orb/internal/type/base_model.rb +++ b/lib/orb/internal/type/base_model.rb @@ -4,14 +4,6 @@ module Orb module Internal module Type # @abstract - # - # @example - # # `amount_discount` is a `Orb::Models::AmountDiscount` - # amount_discount => { - # amount_discount: amount_discount, - # applies_to_price_ids: applies_to_price_ids, - # discount_type: discount_type - # } class BaseModel extend Orb::Internal::Type::Converter @@ -93,11 +85,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 Orb::Errors::ConversionError.new(message) end end @@ -165,19 +159,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 <= Orb::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 # @@ -291,6 +299,8 @@ def dump(value, state:) end end + # @api public + # # Returns the raw value associated with the given key, if found. Otherwise, nil is # returned. # @@ -309,6 +319,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 @@ -339,6 +351,8 @@ def deconstruct_keys(keys) end class << self + # @api private + # # @param model [Orb::Internal::Type::BaseModel] # # @return [Hash{Symbol=>Object}] @@ -359,11 +373,15 @@ def walk(model) end end + # @api public + # # @param a [Object] # # @return [String] def to_json(*a) = Orb::Internal::Type::Converter.dump(self.class, self).to_json(*a) + # @api public + # # @param a [Object] # # @return [String] @@ -371,7 +389,7 @@ def to_yaml(*a) = Orb::Internal::Type::Converter.dump(self.class, self).to_yaml( # Create a new instance of a model. # - # @param data [Hash{Symbol=>Object}, Orb::Internal::Type::BaseModel] + # @param data [Hash{Symbol=>Object}, self] def initialize(data = {}) case Orb::Internal::Util.coerce_hash(data) in Hash => coerced @@ -405,7 +423,7 @@ def inspect(depth: 0) end end - # @api private + # @api public # # @return [String] def to_s = self.class.walk(@data).to_s diff --git a/lib/orb/internal/type/base_page.rb b/lib/orb/internal/type/base_page.rb index 009ecf00..8585169c 100644 --- a/lib/orb/internal/type/base_page.rb +++ b/lib/orb/internal/type/base_page.rb @@ -3,19 +3,27 @@ module Orb 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 [Orb::Errors::APIError] - # @return [Orb::Internal::Type::BasePage] + # @return [self] def next_page = (raise NotImplementedError) + # @api public + # # @param blk [Proc] # # @yieldparam [generic] diff --git a/lib/orb/internal/type/boolean.rb b/lib/orb/internal/type/boolean.rb index c05da5d9..dfac05cb 100644 --- a/lib/orb/internal/type/boolean.rb +++ b/lib/orb/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/orb/internal/type/converter.rb b/lib/orb/internal/type/converter.rb index 3675e242..33a6b19c 100644 --- a/lib/orb/internal/type/converter.rb +++ b/lib/orb/internal/type/converter.rb @@ -43,7 +43,10 @@ def dump(value, state:) value.string in Pathname | IO state[:can_retry] = false if value.is_a?(IO) - Orb::Internal::Util::SerializationAdapter.new(value) + Orb::FilePart.new(value) + in Orb::FilePart + state[:can_retry] = false if value.content.is_a?(IO) + value else value end diff --git a/lib/orb/internal/type/enum.rb b/lib/orb/internal/type/enum.rb index e3ddcc6a..57999bdc 100644 --- a/lib/orb/internal/type/enum.rb +++ b/lib/orb/internal/type/enum.rb @@ -42,18 +42,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] @@ -63,6 +62,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/orb/internal/type/io_like.rb b/lib/orb/internal/type/file_input.rb similarity index 56% rename from lib/orb/internal/type/io_like.rb rename to lib/orb/internal/type/file_input.rb index 7c5c56c7..183c2f8e 100644 --- a/lib/orb/internal/type/io_like.rb +++ b/lib/orb/internal/type/file_input.rb @@ -7,28 +7,35 @@ module Type # # @abstract # - # Either `Pathname` or `StringIO`. - class IOLike + # Either `Pathname` or `StringIO`, or `IO`, or `Orb::Internal::Type::FileInput`. + # + # Note: when `IO` is used, all retries are disabled, since many IO` streams are + # not rewindable. + class FileInput extend Orb::Internal::Type::Converter private_class_method :new + # @api public + # # @param other [Object] # # @return [Boolean] def self.===(other) case other - in StringIO | Pathname | IO + in Pathname | StringIO | IO | String | Orb::FilePart true else false end end + # @api public + # # @param other [Object] # # @return [Boolean] - def self.==(other) = other.is_a?(Class) && other <= Orb::Internal::Type::IOLike + def self.==(other) = other.is_a?(Class) && other <= Orb::Internal::Type::FileInput class << self # @api private @@ -59,17 +66,28 @@ def coerce(value, state:) end end - # @!parse - # # @api private - # # - # # @param value [Pathname, StringIO, IO, String, Object] - # # - # # @param state [Hash{Symbol=>Object}] . - # # - # # @option state [Boolean] :can_retry - # # - # # @return [Pathname, StringIO, IO, String, Object] - # def dump(value, state:) = super + # @api private + # + # @param value [Pathname, StringIO, IO, String, Object] + # + # @param state [Hash{Symbol=>Object}] . + # + # @option state [Boolean] :can_retry + # + # @return [Pathname, StringIO, IO, String, Object] + def dump(value, state:) + # rubocop:disable Lint/DuplicateBranch + case value + in IO + state[:can_retry] = false + in Orb::FilePart if value.content.is_a?(IO) + state[:can_retry] = false + else + end + # rubocop:enable Lint/DuplicateBranch + + value + end end end end diff --git a/lib/orb/internal/type/hash_of.rb b/lib/orb/internal/type/hash_of.rb index 56073fbc..f52830a1 100644 --- a/lib/orb/internal/type/hash_of.rb +++ b/lib/orb/internal/type/hash_of.rb @@ -28,8 +28,12 @@ class HashOf # @option spec [Proc] :union # # @option spec [Boolean] :"nil?" + # + # @return [Orb::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/orb/internal/type/request_parameters.rb b/lib/orb/internal/type/request_parameters.rb index 65764d03..619f50d8 100644 --- a/lib/orb/internal/type/request_parameters.rb +++ b/lib/orb/internal/type/request_parameters.rb @@ -12,9 +12,8 @@ module RequestParameters # @param mod [Module] def self.included(mod) - return unless mod <= Orb::Internal::Type::BaseModel + raise ArgumentError.new(mod) unless mod <= Orb::Internal::Type::BaseModel - mod.extend(Orb::Internal::Type::RequestParameters::Converter) mod.optional(:request_options, Orb::RequestOptions) end diff --git a/lib/orb/internal/type/union.rb b/lib/orb/internal/type/union.rb index 98cd9b31..b147d593 100644 --- a/lib/orb/internal/type/union.rb +++ b/lib/orb/internal/type/union.rb @@ -58,7 +58,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. @@ -127,6 +127,8 @@ def variants = derefed_variants.map(&:last) # rubocop:disable Style/HashEachMethods # rubocop:disable Style/CaseEquality + # @api public + # # @param other [Object] # # @return [Boolean] @@ -136,6 +138,8 @@ def ===(other) end end + # @api public + # # @param other [Object] # # @return [Boolean] @@ -143,6 +147,11 @@ def ==(other) Orb::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/orb/internal/type/unknown.rb b/lib/orb/internal/type/unknown.rb index 0110bf0a..1b5a1596 100644 --- a/lib/orb/internal/type/unknown.rb +++ b/lib/orb/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/orb/internal/util.rb b/lib/orb/internal/util.rb index 6290e5f4..e05d1774 100644 --- a/lib/orb/internal/util.rb +++ b/lib/orb/internal/util.rb @@ -175,18 +175,17 @@ def deep_merge(*values, sentinel: nil, concat: false) # @api private # # @param data [Hash{Symbol=>Object}, Array, Object] - # @param pick [Symbol, Integer, Array, nil] - # @param sentinel [Object, nil] + # @param pick [Symbol, Integer, Array, Proc, nil] # @param blk [Proc, nil] # # @return [Object, nil] - def dig(data, pick, sentinel = nil, &blk) - case [data, pick, blk] - in [_, nil, nil] + def dig(data, pick, &blk) + case [data, pick] + in [_, nil] data - in [Hash, Symbol, _] | [Array, Integer, _] - blk.nil? ? data.fetch(pick, sentinel) : data.fetch(pick, &blk) - in [Hash | Array, Array, _] + in [Hash, Symbol] | [Array, Integer] + data.fetch(pick) { blk&.call } + in [Hash | Array, Array] pick.reduce(data) do |acc, key| case acc in Hash if acc.key?(key) @@ -194,11 +193,13 @@ def dig(data, pick, sentinel = nil, &blk) in Array if key.is_a?(Integer) && key < acc.length acc[key] else - return blk.nil? ? sentinel : blk.call + return blk&.call end end - in _ - blk.nil? ? sentinel : blk.call + in [_, Proc] + pick.call(data) + else + blk&.call end end end @@ -348,27 +349,6 @@ def normalized_headers(*headers) end end - # @api private - class SerializationAdapter - # @return [Pathname, IO] - attr_reader :inner - - # @param a [Object] - # - # @return [String] - def to_json(*a) = (inner.is_a?(IO) ? inner.read : inner.read(binmode: true)).to_json(*a) - - # @param a [Object] - # - # @return [String] - def to_yaml(*a) = (inner.is_a?(IO) ? inner.read : inner.read(binmode: true)).to_yaml(*a) - - # @api private - # - # @param inner [Pathname, IO] - def initialize(inner) = @inner = inner - end - # @api private # # An adapter that satisfies the IO interface required by `::IO.copy_stream` @@ -471,46 +451,44 @@ def writable_enum(&blk) end end + # @type [Regexp] + JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)} + # @type [Regexp] + JSONL_CONTENT = %r{^application/(?:x-)?jsonl} + class << self # @api private # # @param y [Enumerator::Yielder] - # @param boundary [String] - # @param key [Symbol, String] # @param val [Object] # @param closing [Array] - private def write_multipart_chunk(y, boundary:, key:, val:, closing:) - val = val.inner if val.is_a?(Orb::Internal::Util::SerializationAdapter) + # @param content_type [String, nil] + private def write_multipart_content(y, val:, closing:, content_type: nil) + content_type ||= "application/octet-stream" - y << "--#{boundary}\r\n" - y << "Content-Disposition: form-data" - unless key.nil? - name = ERB::Util.url_encode(key.to_s) - y << "; name=\"#{name}\"" - end - case val - in Pathname | IO - filename = ERB::Util.url_encode(File.basename(val.to_path)) - y << "; filename=\"#{filename}\"" - else - end - y << "\r\n" case val + in Orb::FilePart + return write_multipart_content( + y, + val: val.content, + closing: closing, + content_type: val.content_type + ) in Pathname - y << "Content-Type: application/octet-stream\r\n\r\n" + y << "Content-Type: #{content_type}\r\n\r\n" io = val.open(binmode: true) closing << io.method(:close) IO.copy_stream(io, y) in IO - y << "Content-Type: application/octet-stream\r\n\r\n" + y << "Content-Type: #{content_type}\r\n\r\n" IO.copy_stream(val, y) in StringIO - y << "Content-Type: application/octet-stream\r\n\r\n" + y << "Content-Type: #{content_type}\r\n\r\n" y << val.string in String - y << "Content-Type: application/octet-stream\r\n\r\n" + y << "Content-Type: #{content_type}\r\n\r\n" y << val.to_s - in _ if primitive?(val) + in -> { primitive?(_1) } y << "Content-Type: text/plain\r\n\r\n" y << val.to_s else @@ -520,6 +498,36 @@ class << self y << "\r\n" end + # @api private + # + # @param y [Enumerator::Yielder] + # @param boundary [String] + # @param key [Symbol, String] + # @param val [Object] + # @param closing [Array] + private def write_multipart_chunk(y, boundary:, key:, val:, closing:) + y << "--#{boundary}\r\n" + y << "Content-Disposition: form-data" + + unless key.nil? + name = ERB::Util.url_encode(key.to_s) + y << "; name=\"#{name}\"" + end + + case val + in Orb::FilePart unless val.filename.nil? + filename = ERB::Util.url_encode(val.filename) + y << "; filename=\"#{filename}\"" + in Pathname | IO + filename = ERB::Util.url_encode(File.basename(val.to_path)) + y << "; filename=\"#{filename}\"" + else + end + y << "\r\n" + + write_multipart_content(y, val: val, closing: closing) + end + # @api private # # @param body [Object] @@ -560,14 +568,12 @@ class << self # @return [Object] def encode_content(headers, body) content_type = headers["content-type"] - body = body.inner if body.is_a?(Orb::Internal::Util::SerializationAdapter) - case [content_type, body] - in [%r{^application/(?:vnd\.api\+)?json}, Hash | Array | -> { primitive?(_1) }] + in [Orb::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }] [headers, JSON.fast_generate(body)] - in [%r{^application/(?:x-)?jsonl}, Enumerable] unless body.is_a?(StringIO) || body.is_a?(IO) + in [Orb::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(Orb::Internal::Type::FileInput) [headers, body.lazy.map { JSON.fast_generate(_1) }] - in [%r{^multipart/form-data}, Hash | Pathname | StringIO | IO] + in [%r{^multipart/form-data}, Hash | Orb::Internal::Type::FileInput] boundary, strio = encode_multipart_streaming(body) headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"} [headers, strio] @@ -575,6 +581,8 @@ def encode_content(headers, body) [headers, body.to_s] in [_, StringIO] [headers, body.string] + in [_, Orb::FilePart] + [headers, body.content] else [headers, body] end @@ -611,7 +619,7 @@ def force_charset!(content_type, text:) # @return [Object] def decode_content(headers, stream:, suppress_error: false) case (content_type = headers["content-type"]) - in %r{^application/(?:vnd\.api\+)?json} + in Orb::Internal::Util::JSON_CONTENT json = stream.to_a.join begin JSON.parse(json, symbolize_names: true) @@ -619,7 +627,7 @@ def decode_content(headers, stream:, suppress_error: false) raise e unless suppress_error json end - in %r{^application/(?:x-)?jsonl} + in Orb::Internal::Util::JSONL_CONTENT lines = decode_lines(stream) chain_fused(lines) do |y| lines.each { y << JSON.parse(_1, symbolize_names: true) } diff --git a/lib/orb/models/alert.rb b/lib/orb/models/alert.rb index 95dd44f0..20d1a7f8 100644 --- a/lib/orb/models/alert.rb +++ b/lib/orb/models/alert.rb @@ -65,27 +65,36 @@ class Alert < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::Alert::Type] required :type, enum: -> { Orb::Models::Alert::Type } - # @!parse - # # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending, - # # usage, or credit balance and trigger webhooks when a threshold is exceeded. - # # - # # Alerts created through the API can be scoped to either customers or - # # subscriptions. - # # - # # @param id [String] - # # @param created_at [Time] - # # @param currency [String, nil] - # # @param customer [Orb::Models::Alert::Customer, nil] - # # @param enabled [Boolean] - # # @param metric [Orb::Models::Alert::Metric, nil] - # # @param plan [Orb::Models::Alert::Plan, nil] - # # @param subscription [Orb::Models::Alert::Subscription, nil] - # # @param thresholds [Array, nil] - # # @param type [Symbol, Orb::Models::Alert::Type] - # # - # def initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:) + # Some parameter documentations has been truncated, see {Orb::Models::Alert} for + # more details. + # + # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending, + # usage, or credit balance and trigger webhooks when a threshold is exceeded. + # + # Alerts created through the API can be scoped to either customers or + # subscriptions. + # + # @param id [String] Also referred to as alert_id in this documentation. + # + # @param created_at [Time] The creation time of the resource in Orb. + # + # @param currency [String, nil] The name of the currency the credit balance or invoice cost is denominated in. + # + # @param customer [Orb::Models::Alert::Customer, nil] The customer the alert applies to. + # + # @param enabled [Boolean] Whether the alert is enabled or disabled. + # + # @param metric [Orb::Models::Alert::Metric, nil] The metric the alert applies to. + # + # @param plan [Orb::Models::Alert::Plan, nil] The plan the alert applies to. + # + # @param subscription [Orb::Models::Alert::Subscription, nil] The subscription the alert applies to. + # + # @param thresholds [Array, nil] The thresholds that define the conditions under which the alert will be triggere + # ... + # + # @param type [Symbol, Orb::Models::Alert::Type] The type of alert. This must be a valid alert type. # @see Orb::Models::Alert#customer class Customer < Orb::Internal::Type::BaseModel @@ -99,15 +108,11 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # The customer the alert applies to. - # # - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # The customer the alert applies to. + # + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Alert#metric @@ -117,14 +122,10 @@ class Metric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # The metric the alert applies to. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # The metric the alert applies to. + # + # @param id [String] end # @see Orb::Models::Alert#plan @@ -152,17 +153,20 @@ class Plan < Orb::Internal::Type::BaseModel # @return [String] required :plan_version, String - # @!parse - # # The plan the alert applies to. - # # - # # @param id [String, nil] - # # @param external_plan_id [String, nil] - # # @param name [String, nil] - # # @param plan_version [String] - # # - # def initialize(id:, external_plan_id:, name:, plan_version:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_plan_id:, name:, plan_version:) + # Some parameter documentations has been truncated, see {Orb::Models::Alert::Plan} + # for more details. + # + # The plan the alert applies to. + # + # @param id [String, nil] + # + # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a + # ... + # + # @param name [String, nil] + # + # @param plan_version [String] end # @see Orb::Models::Alert#subscription @@ -172,14 +176,10 @@ class Subscription < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # The subscription the alert applies to. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # The subscription the alert applies to. + # + # @param id [String] end class Threshold < Orb::Internal::Type::BaseModel @@ -191,15 +191,15 @@ class Threshold < Orb::Internal::Type::BaseModel # @return [Float] required :value, Float - # @!parse - # # Thresholds are used to define the conditions under which an alert will be - # # triggered. - # # - # # @param value [Float] - # # - # def initialize(value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(value:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Alert::Threshold} for more details. + # + # Thresholds are used to define the conditions under which an alert will be + # triggered. + # + # @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will + # ... end # The type of alert. This must be a valid alert type. @@ -214,11 +214,8 @@ module Type USAGE_EXCEEDED = :usage_exceeded COST_EXCEEDED = :cost_exceeded - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/alert_create_for_customer_params.rb b/lib/orb/models/alert_create_for_customer_params.rb index b3fca12f..47573d14 100644 --- a/lib/orb/models/alert_create_for_customer_params.rb +++ b/lib/orb/models/alert_create_for_customer_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Alerts#create_for_customer class AlertCreateForCustomerParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute currency @@ -28,15 +27,14 @@ class AlertCreateForCustomerParams < Orb::Internal::Type::BaseModel -> { Orb::Internal::Type::ArrayOf[Orb::Models::AlertCreateForCustomerParams::Threshold] }, nil?: true - # @!parse - # # @param currency [String] - # # @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] - # # @param thresholds [Array, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(currency:, type:, thresholds: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(currency:, type:, thresholds: nil, request_options: {}) + # @param currency [String] The case sensitive currency or custom pricing unit to use for this alert. + # + # @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type. + # + # @param thresholds [Array, nil] The thresholds that define the values at which the alert will be triggered. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] # The type of alert to create. This must be a valid alert type. module Type @@ -46,11 +44,8 @@ module Type CREDIT_BALANCE_DROPPED = :credit_balance_dropped CREDIT_BALANCE_RECOVERED = :credit_balance_recovered - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class Threshold < Orb::Internal::Type::BaseModel @@ -62,15 +57,15 @@ class Threshold < Orb::Internal::Type::BaseModel # @return [Float] required :value, Float - # @!parse - # # Thresholds are used to define the conditions under which an alert will be - # # triggered. - # # - # # @param value [Float] - # # - # def initialize(value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(value:) + # Some parameter documentations has been truncated, see + # {Orb::Models::AlertCreateForCustomerParams::Threshold} for more details. + # + # Thresholds are used to define the conditions under which an alert will be + # triggered. + # + # @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will + # ... end end end diff --git a/lib/orb/models/alert_create_for_external_customer_params.rb b/lib/orb/models/alert_create_for_external_customer_params.rb index 7b167b23..d26085dd 100644 --- a/lib/orb/models/alert_create_for_external_customer_params.rb +++ b/lib/orb/models/alert_create_for_external_customer_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Alerts#create_for_external_customer class AlertCreateForExternalCustomerParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute currency @@ -28,15 +27,14 @@ class AlertCreateForExternalCustomerParams < Orb::Internal::Type::BaseModel -> { Orb::Internal::Type::ArrayOf[Orb::Models::AlertCreateForExternalCustomerParams::Threshold] }, nil?: true - # @!parse - # # @param currency [String] - # # @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] - # # @param thresholds [Array, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(currency:, type:, thresholds: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(currency:, type:, thresholds: nil, request_options: {}) + # @param currency [String] The case sensitive currency or custom pricing unit to use for this alert. + # + # @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type. + # + # @param thresholds [Array, nil] The thresholds that define the values at which the alert will be triggered. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] # The type of alert to create. This must be a valid alert type. module Type @@ -46,11 +44,8 @@ module Type CREDIT_BALANCE_DROPPED = :credit_balance_dropped CREDIT_BALANCE_RECOVERED = :credit_balance_recovered - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class Threshold < Orb::Internal::Type::BaseModel @@ -62,15 +57,15 @@ class Threshold < Orb::Internal::Type::BaseModel # @return [Float] required :value, Float - # @!parse - # # Thresholds are used to define the conditions under which an alert will be - # # triggered. - # # - # # @param value [Float] - # # - # def initialize(value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(value:) + # Some parameter documentations has been truncated, see + # {Orb::Models::AlertCreateForExternalCustomerParams::Threshold} for more details. + # + # Thresholds are used to define the conditions under which an alert will be + # triggered. + # + # @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will + # ... end end end diff --git a/lib/orb/models/alert_create_for_subscription_params.rb b/lib/orb/models/alert_create_for_subscription_params.rb index 8e49770c..39319002 100644 --- a/lib/orb/models/alert_create_for_subscription_params.rb +++ b/lib/orb/models/alert_create_for_subscription_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Alerts#create_for_subscription class AlertCreateForSubscriptionParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute thresholds @@ -27,15 +26,14 @@ class AlertCreateForSubscriptionParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :metric_id, String, nil?: true - # @!parse - # # @param thresholds [Array] - # # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] - # # @param metric_id [String, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(thresholds:, type:, metric_id: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(thresholds:, type:, metric_id: nil, request_options: {}) + # @param thresholds [Array] The thresholds that define the values at which the alert will be triggered. + # + # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type. + # + # @param metric_id [String, nil] The metric to track usage for. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] class Threshold < Orb::Internal::Type::BaseModel # @!attribute value @@ -46,15 +44,15 @@ class Threshold < Orb::Internal::Type::BaseModel # @return [Float] required :value, Float - # @!parse - # # Thresholds are used to define the conditions under which an alert will be - # # triggered. - # # - # # @param value [Float] - # # - # def initialize(value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(value:) + # Some parameter documentations has been truncated, see + # {Orb::Models::AlertCreateForSubscriptionParams::Threshold} for more details. + # + # Thresholds are used to define the conditions under which an alert will be + # triggered. + # + # @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will + # ... end # The type of alert to create. This must be a valid alert type. @@ -64,11 +62,8 @@ module Type USAGE_EXCEEDED = :usage_exceeded COST_EXCEEDED = :cost_exceeded - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/alert_disable_params.rb b/lib/orb/models/alert_disable_params.rb index 10027895..4c3e373f 100644 --- a/lib/orb/models/alert_disable_params.rb +++ b/lib/orb/models/alert_disable_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Alerts#disable class AlertDisableParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute subscription_id @@ -14,13 +13,10 @@ class AlertDisableParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :subscription_id, String, nil?: true - # @!parse - # # @param subscription_id [String, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(subscription_id: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(subscription_id: nil, request_options: {}) + # @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/alert_enable_params.rb b/lib/orb/models/alert_enable_params.rb index 0baf55d0..f4624f5a 100644 --- a/lib/orb/models/alert_enable_params.rb +++ b/lib/orb/models/alert_enable_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Alerts#enable class AlertEnableParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute subscription_id @@ -14,13 +13,10 @@ class AlertEnableParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :subscription_id, String, nil?: true - # @!parse - # # @param subscription_id [String, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(subscription_id: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(subscription_id: nil, request_options: {}) + # @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/alert_list_params.rb b/lib/orb/models/alert_list_params.rb index fd151d11..f9883651 100644 --- a/lib/orb/models/alert_list_params.rb +++ b/lib/orb/models/alert_list_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Alerts#list class AlertListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute created_at_gt @@ -47,51 +46,42 @@ class AlertListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :external_customer_id, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - # @!attribute subscription_id # Fetch alerts scoped to this subscription_id # # @return [String, nil] optional :subscription_id, String, nil?: true - # @!parse - # # @param created_at_gt [Time, nil] - # # @param created_at_gte [Time, nil] - # # @param created_at_lt [Time, nil] - # # @param created_at_lte [Time, nil] - # # @param cursor [String, nil] - # # @param customer_id [String, nil] - # # @param external_customer_id [String, nil] - # # @param limit [Integer] - # # @param subscription_id [String, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # created_at_gt: nil, - # created_at_gte: nil, - # created_at_lt: nil, - # created_at_lte: nil, - # cursor: nil, - # customer_id: nil, - # external_customer_id: nil, - # limit: nil, - # subscription_id: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, subscription_id: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::AlertListParams} for more details. + # + # @param created_at_gt [Time, nil] + # + # @param created_at_gte [Time, nil] + # + # @param created_at_lt [Time, nil] + # + # @param created_at_lte [Time, nil] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param customer_id [String, nil] Fetch alerts scoped to this customer_id + # + # @param external_customer_id [String, nil] Fetch alerts scoped to this external_customer_id + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param subscription_id [String, nil] Fetch alerts scoped to this subscription_id + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/alert_retrieve_params.rb b/lib/orb/models/alert_retrieve_params.rb index ce716483..e2a228ad 100644 --- a/lib/orb/models/alert_retrieve_params.rb +++ b/lib/orb/models/alert_retrieve_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Alerts#retrieve class AlertRetrieveParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/alert_update_params.rb b/lib/orb/models/alert_update_params.rb index 9827962a..adc1b0cc 100644 --- a/lib/orb/models/alert_update_params.rb +++ b/lib/orb/models/alert_update_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Alerts#update class AlertUpdateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute thresholds @@ -14,13 +13,10 @@ class AlertUpdateParams < Orb::Internal::Type::BaseModel # @return [Array] required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Models::AlertUpdateParams::Threshold] } - # @!parse - # # @param thresholds [Array] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(thresholds:, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(thresholds:, request_options: {}) + # @param thresholds [Array] The thresholds that define the values at which the alert will be triggered. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] class Threshold < Orb::Internal::Type::BaseModel # @!attribute value @@ -31,15 +27,15 @@ class Threshold < Orb::Internal::Type::BaseModel # @return [Float] required :value, Float - # @!parse - # # Thresholds are used to define the conditions under which an alert will be - # # triggered. - # # - # # @param value [Float] - # # - # def initialize(value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(value:) + # Some parameter documentations has been truncated, see + # {Orb::Models::AlertUpdateParams::Threshold} for more details. + # + # Thresholds are used to define the conditions under which an alert will be + # triggered. + # + # @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will + # ... end end end diff --git a/lib/orb/models/amount_discount.rb b/lib/orb/models/amount_discount.rb index e4cd8fc1..27097f2d 100644 --- a/lib/orb/models/amount_discount.rb +++ b/lib/orb/models/amount_discount.rb @@ -26,15 +26,18 @@ class AmountDiscount < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reason, String, nil?: true - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param discount_type [Symbol, Orb::Models::AmountDiscount::DiscountType] - # # @param reason [String, nil] - # # - # def initialize(amount_discount:, applies_to_price_ids:, discount_type:, reason: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, discount_type:, reason: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::AmountDiscount} for more details. + # + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] List of price_ids that this discount applies to. For plan/plan phase discounts, + # ... + # + # @param discount_type [Symbol, Orb::Models::AmountDiscount::DiscountType] + # + # @param reason [String, nil] # @see Orb::Models::AmountDiscount#discount_type module DiscountType @@ -42,11 +45,8 @@ module DiscountType AMOUNT = :amount - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/billable_metric.rb b/lib/orb/models/billable_metric.rb index 11e201c1..bf028599 100644 --- a/lib/orb/models/billable_metric.rb +++ b/lib/orb/models/billable_metric.rb @@ -41,21 +41,27 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::BillableMetric::Status] required :status, enum: -> { Orb::Models::BillableMetric::Status } - # @!parse - # # The Metric resource represents a calculation of a quantity based on events. - # # Metrics are defined by the query that transforms raw usage events into - # # meaningful values for your customers. - # # - # # @param id [String] - # # @param description [String, nil] - # # @param item [Orb::Models::Item] - # # @param metadata [Hash{Symbol=>String}] - # # @param name [String] - # # @param status [Symbol, Orb::Models::BillableMetric::Status] - # # - # def initialize(id:, description:, item:, metadata:, name:, status:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, description:, item:, metadata:, name:, status:) + # Some parameter documentations has been truncated, see + # {Orb::Models::BillableMetric} for more details. + # + # The Metric resource represents a calculation of a quantity based on events. + # Metrics are defined by the query that transforms raw usage events into + # meaningful values for your customers. + # + # @param id [String] + # + # @param description [String, nil] + # + # @param item [Orb::Models::Item] The Item resource represents a sellable product or good. Items are associated wi + # ... + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param name [String] + # + # @param status [Symbol, Orb::Models::BillableMetric::Status] # @see Orb::Models::BillableMetric#status module Status @@ -65,11 +71,8 @@ module Status DRAFT = :draft ARCHIVED = :archived - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/billing_cycle_relative_date.rb b/lib/orb/models/billing_cycle_relative_date.rb index 726ca375..a273a2a4 100644 --- a/lib/orb/models/billing_cycle_relative_date.rb +++ b/lib/orb/models/billing_cycle_relative_date.rb @@ -8,11 +8,8 @@ module BillingCycleRelativeDate START_OF_TERM = :start_of_term END_OF_TERM = :end_of_term - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/coupon.rb b/lib/orb/models/coupon.rb index 0e0c71cc..34aa08b2 100644 --- a/lib/orb/models/coupon.rb +++ b/lib/orb/models/coupon.rb @@ -48,24 +48,32 @@ class Coupon < Orb::Internal::Type::BaseModel # @return [Integer] required :times_redeemed, Integer - # @!parse - # # A coupon represents a reusable discount configuration that can be applied either - # # as a fixed or percentage amount to an invoice or subscription. Coupons are - # # activated using a redemption code, which applies the discount to a subscription - # # or invoice. The duration of a coupon determines how long it remains available - # # for use by end users. - # # - # # @param id [String] - # # @param archived_at [Time, nil] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount] - # # @param duration_in_months [Integer, nil] - # # @param max_redemptions [Integer, nil] - # # @param redemption_code [String] - # # @param times_redeemed [Integer] - # # - # def initialize(id:, archived_at:, discount:, duration_in_months:, max_redemptions:, redemption_code:, times_redeemed:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, archived_at:, discount:, duration_in_months:, max_redemptions:, redemption_code:, times_redeemed:) + # Some parameter documentations has been truncated, see {Orb::Models::Coupon} for + # more details. + # + # A coupon represents a reusable discount configuration that can be applied either + # as a fixed or percentage amount to an invoice or subscription. Coupons are + # activated using a redemption code, which applies the discount to a subscription + # or invoice. The duration of a coupon determines how long it remains available + # for use by end users. + # + # @param id [String] Also referred to as coupon_id in this documentation. + # + # @param archived_at [Time, nil] An archived coupon can no longer be redeemed. Active coupons will have a value o + # ... + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount] + # + # @param duration_in_months [Integer, nil] This allows for a coupon's discount to apply for a limited time (determined in m + # ... + # + # @param max_redemptions [Integer, nil] The maximum number of redemptions allowed for this coupon before it is exhausted + # ... + # + # @param redemption_code [String] This string can be used to redeem this coupon for a given subscription. + # + # @param times_redeemed [Integer] The number of times this coupon has been redeemed. # @see Orb::Models::Coupon#discount module Discount @@ -77,9 +85,8 @@ module Discount variant :amount, -> { Orb::Models::AmountDiscount } - # @!parse - # # @return [Array(Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount)] end end end diff --git a/lib/orb/models/coupon_archive_params.rb b/lib/orb/models/coupon_archive_params.rb index b8e058e2..70a7d36a 100644 --- a/lib/orb/models/coupon_archive_params.rb +++ b/lib/orb/models/coupon_archive_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Coupons#archive class CouponArchiveParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/coupon_create_params.rb b/lib/orb/models/coupon_create_params.rb index 39ef9676..644db0a8 100644 --- a/lib/orb/models/coupon_create_params.rb +++ b/lib/orb/models/coupon_create_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Coupons#create class CouponCreateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute discount @@ -33,16 +32,21 @@ class CouponCreateParams < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :max_redemptions, Integer, nil?: true - # @!parse - # # @param discount [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount] - # # @param redemption_code [String] - # # @param duration_in_months [Integer, nil] - # # @param max_redemptions [Integer, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::CouponCreateParams} for more details. + # + # @param discount [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount] + # + # @param redemption_code [String] This string can be used to redeem this coupon for a given subscription. + # + # @param duration_in_months [Integer, nil] This allows for a coupon's discount to apply for a limited time (determined in m + # ... + # + # @param max_redemptions [Integer, nil] The maximum number of redemptions allowed for this coupon before it is exhausted + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] module Discount extend Orb::Internal::Type::Union @@ -64,13 +68,9 @@ class NewCouponPercentageDiscount < Orb::Internal::Type::BaseModel # @return [Float] required :percentage_discount, Float - # @!parse - # # @param percentage_discount [Float] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize(percentage_discount:, discount_type: :percentage, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(percentage_discount:, discount_type: :percentage) + # @param percentage_discount [Float] + # @param discount_type [Symbol, :percentage] end class NewCouponAmountDiscount < Orb::Internal::Type::BaseModel @@ -84,18 +84,13 @@ class NewCouponAmountDiscount < Orb::Internal::Type::BaseModel # @return [Symbol, :amount] required :discount_type, const: :amount - # @!parse - # # @param amount_discount [String] - # # @param discount_type [Symbol, :amount] - # # - # def initialize(amount_discount:, discount_type: :amount, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, discount_type: :amount) + # @param amount_discount [String] + # @param discount_type [Symbol, :amount] end - # @!parse - # # @return [Array(Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount)] end end end diff --git a/lib/orb/models/coupon_fetch_params.rb b/lib/orb/models/coupon_fetch_params.rb index 74327319..3824f038 100644 --- a/lib/orb/models/coupon_fetch_params.rb +++ b/lib/orb/models/coupon_fetch_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Coupons#fetch class CouponFetchParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/coupon_list_params.rb b/lib/orb/models/coupon_list_params.rb index 7f417722..a4fb2670 100644 --- a/lib/orb/models/coupon_list_params.rb +++ b/lib/orb/models/coupon_list_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Coupons#list class CouponListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute cursor @@ -15,16 +14,12 @@ class CouponListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - # @!attribute redemption_code # Filter to coupons matching this redemption code. # @@ -38,16 +33,21 @@ class CouponListParams < Orb::Internal::Type::BaseModel # @return [Boolean, nil] optional :show_archived, Orb::Internal::Type::Boolean, nil?: true - # @!parse - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param redemption_code [String, nil] - # # @param show_archived [Boolean, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::CouponListParams} for more details. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param redemption_code [String, nil] Filter to coupons matching this redemption code. + # + # @param show_archived [Boolean, nil] Show archived coupons as well (by default, this endpoint only returns active cou + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/coupons/subscription_list_params.rb b/lib/orb/models/coupons/subscription_list_params.rb index e47258fc..55aa12e6 100644 --- a/lib/orb/models/coupons/subscription_list_params.rb +++ b/lib/orb/models/coupons/subscription_list_params.rb @@ -5,8 +5,7 @@ module Models module Coupons # @see Orb::Resources::Coupons::Subscriptions#list class SubscriptionListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute cursor @@ -16,24 +15,22 @@ class SubscriptionListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, limit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Coupons::SubscriptionListParams} for more details. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/credit_note.rb b/lib/orb/models/credit_note.rb index 726fadc0..866e9ec4 100644 --- a/lib/orb/models/credit_note.rb +++ b/lib/orb/models/credit_note.rb @@ -91,60 +91,47 @@ class CreditNote < Orb::Internal::Type::BaseModel # @return [Time, nil] required :voided_at, Time, nil?: true - # @!attribute [r] discounts + # @!attribute discounts # Any discounts applied on the original invoice. # # @return [Array, nil] optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote::Discount] } - # @!parse - # # @return [Array] - # attr_writer :discounts - - # @!parse - # # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has - # # been applied to a particular invoice. - # # - # # @param id [String] - # # @param created_at [Time] - # # @param credit_note_number [String] - # # @param credit_note_pdf [String, nil] - # # @param customer [Orb::Models::CreditNote::Customer] - # # @param invoice_id [String] - # # @param line_items [Array] - # # @param maximum_amount_adjustment [Orb::Models::CreditNote::MaximumAmountAdjustment, nil] - # # @param memo [String, nil] - # # @param minimum_amount_refunded [String, nil] - # # @param reason [Symbol, Orb::Models::CreditNote::Reason, nil] - # # @param subtotal [String] - # # @param total [String] - # # @param type [Symbol, Orb::Models::CreditNote::Type] - # # @param voided_at [Time, nil] - # # @param discounts [Array] - # # - # def initialize( - # id:, - # created_at:, - # credit_note_number:, - # credit_note_pdf:, - # customer:, - # invoice_id:, - # line_items:, - # maximum_amount_adjustment:, - # memo:, - # minimum_amount_refunded:, - # reason:, - # subtotal:, - # total:, - # type:, - # voided_at:, - # discounts: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, created_at:, credit_note_number:, credit_note_pdf:, customer:, invoice_id:, line_items:, maximum_amount_adjustment:, memo:, minimum_amount_refunded:, reason:, subtotal:, total:, type:, voided_at:, discounts: nil) + # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has + # been applied to a particular invoice. + # + # @param id [String] The Orb id of this credit note. + # + # @param created_at [Time] The creation time of the resource in Orb. + # + # @param credit_note_number [String] The unique identifier for credit notes. + # + # @param credit_note_pdf [String, nil] A URL to a PDF of the credit note. + # + # @param customer [Orb::Models::CreditNote::Customer] + # + # @param invoice_id [String] The id of the invoice resource that this credit note is applied to. + # + # @param line_items [Array] All of the line items associated with this credit note. + # + # @param maximum_amount_adjustment [Orb::Models::CreditNote::MaximumAmountAdjustment, nil] The maximum amount applied on the original invoice + # + # @param memo [String, nil] An optional memo supplied on the credit note. + # + # @param minimum_amount_refunded [String, nil] Any credited amount from the applied minimum on the invoice. + # + # @param reason [Symbol, Orb::Models::CreditNote::Reason, nil] + # + # @param subtotal [String] The total prior to any creditable invoice-level discounts or minimums. + # + # @param total [String] The total including creditable invoice-level discounts or minimums, and tax. + # + # @param type [Symbol, Orb::Models::CreditNote::Type] + # + # @param voided_at [Time, nil] The time at which the credit note was voided in Orb, if applicable. + # + # @param discounts [Array] Any discounts applied on the original invoice. # @see Orb::Models::CreditNote#customer class Customer < Orb::Internal::Type::BaseModel @@ -158,13 +145,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end class LineItem < Orb::Internal::Type::BaseModel @@ -210,29 +193,28 @@ class LineItem < Orb::Internal::Type::BaseModel # @return [Array] required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote::LineItem::TaxAmount] } - # @!attribute [r] discounts + # @!attribute discounts # Any line item discounts from the invoice's line item. # # @return [Array, nil] optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote::LineItem::Discount] } - # @!parse - # # @return [Array] - # attr_writer :discounts - - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param item_id [String] - # # @param name [String] - # # @param quantity [Float, nil] - # # @param subtotal [String] - # # @param tax_amounts [Array] - # # @param discounts [Array] - # # - # def initialize(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil) + # @param id [String] The Orb id of this resource. + # + # @param amount [String] The amount of the line item, including any line item minimums and discounts. + # + # @param item_id [String] The id of the item associated with this line item. + # + # @param name [String] The name of the corresponding invoice line item. + # + # @param quantity [Float, nil] An optional quantity credited. + # + # @param subtotal [String] The amount of the line item, excluding any line item minimums and discounts. + # + # @param tax_amounts [Array] Any tax amounts applied onto the line item. + # + # @param discounts [Array] Any line item discounts from the invoice's line item. class TaxAmount < Orb::Internal::Type::BaseModel # @!attribute amount @@ -253,14 +235,12 @@ class TaxAmount < Orb::Internal::Type::BaseModel # @return [String, nil] required :tax_rate_percentage, String, nil?: true - # @!parse - # # @param amount [String] - # # @param tax_rate_description [String] - # # @param tax_rate_percentage [String, nil] - # # - # def initialize(amount:, tax_rate_description:, tax_rate_percentage:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:) + # @param amount [String] The amount of additional tax incurred by this tax rate. + # + # @param tax_rate_description [String] The human-readable description of the applied tax rate. + # + # @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100. end class Discount < Orb::Internal::Type::BaseModel @@ -299,29 +279,14 @@ class Discount < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_applied [String] - # # @param applies_to_price_ids [Array] - # # @param discount_type [Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType] - # # @param percentage_discount [Float] - # # @param amount_discount [String, nil] - # # @param reason [String, nil] - # # - # def initialize( - # id:, - # amount_applied:, - # applies_to_price_ids:, - # discount_type:, - # percentage_discount:, - # amount_discount: nil, - # reason: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_applied:, applies_to_price_ids:, discount_type:, percentage_discount:, amount_discount: nil, reason: nil) + # @param id [String] + # @param amount_applied [String] + # @param applies_to_price_ids [Array] + # @param discount_type [Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType] + # @param percentage_discount [Float] + # @param amount_discount [String, nil] + # @param reason [String, nil] # @see Orb::Models::CreditNote::LineItem::Discount#discount_type module DiscountType @@ -330,11 +295,8 @@ module DiscountType PERCENTAGE = :percentage AMOUNT = :amount - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -368,18 +330,14 @@ class MaximumAmountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reason, String, nil?: true - # @!parse - # # The maximum amount applied on the original invoice - # # - # # @param amount_applied [String] - # # @param discount_type [Symbol, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType] - # # @param percentage_discount [Float] - # # @param applies_to_prices [Array, nil] - # # @param reason [String, nil] - # # - # def initialize(amount_applied:, discount_type:, percentage_discount:, applies_to_prices: nil, reason: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_applied:, discount_type:, percentage_discount:, applies_to_prices: nil, reason: nil) + # The maximum amount applied on the original invoice + # + # @param amount_applied [String] + # @param discount_type [Symbol, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType] + # @param percentage_discount [Float] + # @param applies_to_prices [Array, nil] + # @param reason [String, nil] # @see Orb::Models::CreditNote::MaximumAmountAdjustment#discount_type module DiscountType @@ -387,11 +345,8 @@ module DiscountType PERCENTAGE = :percentage - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class AppliesToPrice < Orb::Internal::Type::BaseModel @@ -405,13 +360,9 @@ class AppliesToPrice < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end end @@ -424,11 +375,8 @@ module Reason ORDER_CHANGE = :"Order change" PRODUCT_UNSATISFACTORY = :"Product unsatisfactory" - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::CreditNote#type @@ -438,11 +386,8 @@ module Type REFUND = :refund ADJUSTMENT = :adjustment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class Discount < Orb::Internal::Type::BaseModel @@ -473,16 +418,12 @@ class Discount < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reason, String, nil?: true - # @!parse - # # @param amount_applied [String] - # # @param discount_type [Symbol, Orb::Models::CreditNote::Discount::DiscountType] - # # @param percentage_discount [Float] - # # @param applies_to_prices [Array, nil] - # # @param reason [String, nil] - # # - # def initialize(amount_applied:, discount_type:, percentage_discount:, applies_to_prices: nil, reason: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_applied:, discount_type:, percentage_discount:, applies_to_prices: nil, reason: nil) + # @param amount_applied [String] + # @param discount_type [Symbol, Orb::Models::CreditNote::Discount::DiscountType] + # @param percentage_discount [Float] + # @param applies_to_prices [Array, nil] + # @param reason [String, nil] # @see Orb::Models::CreditNote::Discount#discount_type module DiscountType @@ -490,11 +431,8 @@ module DiscountType PERCENTAGE = :percentage - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class AppliesToPrice < Orb::Internal::Type::BaseModel @@ -508,13 +446,9 @@ class AppliesToPrice < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end end end diff --git a/lib/orb/models/credit_note_create_params.rb b/lib/orb/models/credit_note_create_params.rb index 583785e9..9dc58ad0 100644 --- a/lib/orb/models/credit_note_create_params.rb +++ b/lib/orb/models/credit_note_create_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::CreditNotes#create class CreditNoteCreateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute line_items @@ -25,15 +24,14 @@ class CreditNoteCreateParams < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] optional :reason, enum: -> { Orb::Models::CreditNoteCreateParams::Reason }, nil?: true - # @!parse - # # @param line_items [Array] - # # @param memo [String, nil] - # # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(line_items:, memo: nil, reason: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(line_items:, memo: nil, reason: nil, request_options: {}) + # @param line_items [Array] + # + # @param memo [String, nil] An optional memo to attach to the credit note. + # + # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] class LineItem < Orb::Internal::Type::BaseModel # @!attribute amount @@ -48,13 +46,10 @@ class LineItem < Orb::Internal::Type::BaseModel # @return [String] required :invoice_line_item_id, String - # @!parse - # # @param amount [String] - # # @param invoice_line_item_id [String] - # # - # def initialize(amount:, invoice_line_item_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, invoice_line_item_id:) + # @param amount [String] The total amount in the invoice's currency to credit this line item. + # + # @param invoice_line_item_id [String] The ID of the line item to credit. end # An optional reason for the credit note. @@ -66,11 +61,8 @@ module Reason ORDER_CHANGE = :order_change PRODUCT_UNSATISFACTORY = :product_unsatisfactory - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/credit_note_fetch_params.rb b/lib/orb/models/credit_note_fetch_params.rb index 5de2afc8..9009371f 100644 --- a/lib/orb/models/credit_note_fetch_params.rb +++ b/lib/orb/models/credit_note_fetch_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::CreditNotes#fetch class CreditNoteFetchParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/credit_note_list_params.rb b/lib/orb/models/credit_note_list_params.rb index d1724176..b99ecabe 100644 --- a/lib/orb/models/credit_note_list_params.rb +++ b/lib/orb/models/credit_note_list_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::CreditNotes#list class CreditNoteListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute created_at_gt @@ -35,39 +34,30 @@ class CreditNoteListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param created_at_gt [Time, nil] - # # @param created_at_gte [Time, nil] - # # @param created_at_lt [Time, nil] - # # @param created_at_lte [Time, nil] - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # created_at_gt: nil, - # created_at_gte: nil, - # created_at_lt: nil, - # created_at_lte: nil, - # cursor: nil, - # limit: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::CreditNoteListParams} for more details. + # + # @param created_at_gt [Time, nil] + # + # @param created_at_gte [Time, nil] + # + # @param created_at_lt [Time, nil] + # + # @param created_at_lte [Time, nil] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/customer.rb b/lib/orb/models/customer.rb index 27e5c6d8..4fe51f9c 100644 --- a/lib/orb/models/customer.rb +++ b/lib/orb/models/customer.rb @@ -242,78 +242,79 @@ class Customer < Orb::Internal::Type::BaseModel # @return [Orb::Models::Customer::ReportingConfiguration, nil] optional :reporting_configuration, -> { Orb::Models::Customer::ReportingConfiguration }, nil?: true - # @!parse - # # A customer is a buyer of your products, and the other party to the billing - # # relationship. - # # - # # In Orb, customers are assigned system generated identifiers automatically, but - # # it's often desirable to have these match existing identifiers in your system. To - # # avoid having to denormalize Orb ID information, you can pass in an - # # `external_customer_id` with your own identifier. See - # # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # # information about how these aliases work in Orb. - # # - # # In addition to having an identifier in your system, a customer may exist in a - # # payment provider solution like Stripe. Use the `payment_provider_id` and the - # # `payment_provider` enum field to express this mapping. - # # - # # A customer also has a timezone (from the standard - # # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # # your account's timezone. See [Timezone localization](/essentials/timezones) for - # # information on what this timezone parameter influences within Orb. - # # - # # @param id [String] - # # @param additional_emails [Array] - # # @param auto_collection [Boolean] - # # @param balance [String] - # # @param billing_address [Orb::Models::Customer::BillingAddress, nil] - # # @param created_at [Time] - # # @param currency [String, nil] - # # @param email [String] - # # @param email_delivery [Boolean] - # # @param exempt_from_automated_tax [Boolean, nil] - # # @param external_customer_id [String, nil] - # # @param hierarchy [Orb::Models::Customer::Hierarchy] - # # @param metadata [Hash{Symbol=>String}] - # # @param name [String] - # # @param payment_provider [Symbol, Orb::Models::Customer::PaymentProvider, nil] - # # @param payment_provider_id [String, nil] - # # @param portal_url [String, nil] - # # @param shipping_address [Orb::Models::Customer::ShippingAddress, nil] - # # @param tax_id [Orb::Models::Customer::TaxID, nil] - # # @param timezone [String] - # # @param accounting_sync_configuration [Orb::Models::Customer::AccountingSyncConfiguration, nil] - # # @param reporting_configuration [Orb::Models::Customer::ReportingConfiguration, nil] - # # - # def initialize( - # id:, - # additional_emails:, - # auto_collection:, - # balance:, - # billing_address:, - # created_at:, - # currency:, - # email:, - # email_delivery:, - # exempt_from_automated_tax:, - # external_customer_id:, - # hierarchy:, - # metadata:, - # name:, - # payment_provider:, - # payment_provider_id:, - # portal_url:, - # shipping_address:, - # tax_id:, - # timezone:, - # accounting_sync_configuration: nil, - # reporting_configuration: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, additional_emails:, auto_collection:, balance:, billing_address:, created_at:, currency:, email:, email_delivery:, exempt_from_automated_tax:, external_customer_id:, hierarchy:, metadata:, name:, payment_provider:, payment_provider_id:, portal_url:, shipping_address:, tax_id:, timezone:, accounting_sync_configuration: nil, reporting_configuration: nil) + # Some parameter documentations has been truncated, see {Orb::Models::Customer} + # for more details. + # + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. + # + # @param id [String] + # + # @param additional_emails [Array] + # + # @param auto_collection [Boolean] + # + # @param balance [String] The customer's current balance in their currency. + # + # @param billing_address [Orb::Models::Customer::BillingAddress, nil] + # + # @param created_at [Time] + # + # @param currency [String, nil] + # + # @param email [String] A valid customer email, to be used for notifications. When Orb triggers payment + # ... + # + # @param email_delivery [Boolean] + # + # @param exempt_from_automated_tax [Boolean, nil] + # + # @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst + # ... + # + # @param hierarchy [Orb::Models::Customer::Hierarchy] The hierarchical relationships for this customer. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param name [String] The full name of the customer + # + # @param payment_provider [Symbol, Orb::Models::Customer::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe + # ... + # + # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i + # ... + # + # @param portal_url [String, nil] + # + # @param shipping_address [Orb::Models::Customer::ShippingAddress, nil] + # + # @param tax_id [Orb::Models::Customer::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad + # ... + # + # @param timezone [String] A timezone identifier from the IANA timezone database, such as "America/Los_Ange + # ... + # + # @param accounting_sync_configuration [Orb::Models::Customer::AccountingSyncConfiguration, nil] + # + # @param reporting_configuration [Orb::Models::Customer::ReportingConfiguration, nil] # @see Orb::Models::Customer#billing_address class BillingAddress < Orb::Internal::Type::BaseModel @@ -347,17 +348,13 @@ class BillingAddress < Orb::Internal::Type::BaseModel # @return [String, nil] required :state, String, nil?: true - # @!parse - # # @param city [String, nil] - # # @param country [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:) + # @param city [String, nil] + # @param country [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end # @see Orb::Models::Customer#hierarchy @@ -372,15 +369,11 @@ class Hierarchy < Orb::Internal::Type::BaseModel # @return [Orb::Models::Customer::Hierarchy::Parent, nil] required :parent, -> { Orb::Models::Customer::Hierarchy::Parent }, nil?: true - # @!parse - # # The hierarchical relationships for this customer. - # # - # # @param children [Array] - # # @param parent [Orb::Models::Customer::Hierarchy::Parent, nil] - # # - # def initialize(children:, parent:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(children:, parent:) + # The hierarchical relationships for this customer. + # + # @param children [Array] + # @param parent [Orb::Models::Customer::Hierarchy::Parent, nil] class Child < Orb::Internal::Type::BaseModel # @!attribute id @@ -393,13 +386,9 @@ class Child < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customer::Hierarchy#parent @@ -414,13 +403,9 @@ class Parent < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end end @@ -438,11 +423,8 @@ module PaymentProvider STRIPE_INVOICE = :stripe_invoice NETSUITE = :netsuite - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Customer#shipping_address @@ -477,17 +459,13 @@ class ShippingAddress < Orb::Internal::Type::BaseModel # @return [String, nil] required :state, String, nil?: true - # @!parse - # # @param city [String, nil] - # # @param country [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:) + # @param city [String, nil] + # @param country [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end # @see Orb::Models::Customer#tax_id @@ -507,120 +485,116 @@ class TaxID < Orb::Internal::Type::BaseModel # @return [String] required :value, String - # @!parse - # # Tax IDs are commonly required to be displayed on customer invoices, which are - # # added to the headers of invoices. - # # - # # ### Supported Tax ID Countries and Types - # # - # # | Country | Type | Description | - # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # # | Andorra | `ad_nrt` | Andorran NRT Number | - # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # # | Austria | `eu_vat` | European VAT Number | - # # | Bahrain | `bh_vat` | Bahraini VAT Number | - # # | Belgium | `eu_vat` | European VAT Number | - # # | Bolivia | `bo_tin` | Bolivian Tax ID | - # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # # | Brazil | `br_cpf` | Brazilian CPF Number | - # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # # | Bulgaria | `eu_vat` | European VAT Number | - # # | Canada | `ca_bn` | Canadian BN | - # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # # | Chile | `cl_tin` | Chilean TIN | - # # | China | `cn_tin` | Chinese Tax ID | - # # | Colombia | `co_nit` | Colombian NIT Number | - # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # # | Croatia | `eu_vat` | European VAT Number | - # # | Cyprus | `eu_vat` | European VAT Number | - # # | Czech Republic | `eu_vat` | European VAT Number | - # # | Denmark | `eu_vat` | European VAT Number | - # # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # # | Estonia | `eu_vat` | European VAT Number | - # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # # | Finland | `eu_vat` | European VAT Number | - # # | France | `eu_vat` | European VAT Number | - # # | Georgia | `ge_vat` | Georgian VAT | - # # | Germany | `eu_vat` | European VAT Number | - # # | Greece | `eu_vat` | European VAT Number | - # # | Hong Kong | `hk_br` | Hong Kong BR Number | - # # | Hungary | `eu_vat` | European VAT Number | - # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # # | Iceland | `is_vat` | Icelandic VAT | - # # | India | `in_gst` | Indian GST Number | - # # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # # | Ireland | `eu_vat` | European VAT Number | - # # | Israel | `il_vat` | Israel VAT | - # # | Italy | `eu_vat` | European VAT Number | - # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # # | Latvia | `eu_vat` | European VAT Number | - # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # # | Lithuania | `eu_vat` | European VAT Number | - # # | Luxembourg | `eu_vat` | European VAT Number | - # # | Malaysia | `my_frp` | Malaysian FRP Number | - # # | Malaysia | `my_itn` | Malaysian ITN | - # # | Malaysia | `my_sst` | Malaysian SST Number | - # # | Malta | `eu_vat ` | European VAT Number | - # # | Mexico | `mx_rfc` | Mexican RFC Number | - # # | Netherlands | `eu_vat` | European VAT Number | - # # | New Zealand | `nz_gst` | New Zealand GST Number | - # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # # | Norway | `no_vat` | Norwegian VAT Number | - # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # # | Oman | `om_vat` | Omani VAT Number | - # # | Peru | `pe_ruc` | Peruvian RUC Number | - # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # # | Poland | `eu_vat` | European VAT Number | - # # | Portugal | `eu_vat` | European VAT Number | - # # | Romania | `eu_vat` | European VAT Number | - # # | Romania | `ro_tin` | Romanian Tax ID Number | - # # | Russia | `ru_inn` | Russian INN | - # # | Russia | `ru_kpp` | Russian KPP | - # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # # | Serbia | `rs_pib` | Serbian PIB Number | - # # | Singapore | `sg_gst` | Singaporean GST | - # # | Singapore | `sg_uen` | Singaporean UEN | - # # | Slovakia | `eu_vat` | European VAT Number | - # # | Slovenia | `eu_vat` | European VAT Number | - # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # # | South Africa | `za_vat` | South African VAT Number | - # # | South Korea | `kr_brn` | Korean BRN | - # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # # | Spain | `eu_vat` | European VAT Number | - # # | Sweden | `eu_vat` | European VAT Number | - # # | Switzerland | `ch_vat` | Switzerland VAT Number | - # # | Taiwan | `tw_vat` | Taiwanese VAT | - # # | Thailand | `th_vat` | Thai VAT | - # # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # # | Ukraine | `ua_vat` | Ukrainian VAT | - # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # # | United States | `us_ein` | United States EIN | - # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | - # # - # # @param country [Symbol, Orb::Models::Customer::TaxID::Country] - # # @param type [Symbol, Orb::Models::Customer::TaxID::Type] - # # @param value [String] - # # - # def initialize(country:, type:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(country:, type:, value:) + # Tax IDs are commonly required to be displayed on customer invoices, which are + # added to the headers of invoices. + # + # ### Supported Tax ID Countries and Types + # + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # + # @param country [Symbol, Orb::Models::Customer::TaxID::Country] + # @param type [Symbol, Orb::Models::Customer::TaxID::Type] + # @param value [String] # @see Orb::Models::Customer::TaxID#country module Country @@ -705,11 +679,8 @@ module Country VN = :VN ZA = :ZA - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Customer::TaxID#type @@ -788,11 +759,8 @@ module Type VN_TIN = :vn_tin ZA_VAT = :za_vat - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -809,13 +777,9 @@ class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel # @return [Boolean] required :excluded, Orb::Internal::Type::Boolean - # @!parse - # # @param accounting_providers [Array] - # # @param excluded [Boolean] - # # - # def initialize(accounting_providers:, excluded:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(accounting_providers:, excluded:) + # @param accounting_providers [Array] + # @param excluded [Boolean] class AccountingProvider < Orb::Internal::Type::BaseModel # @!attribute external_provider_id @@ -829,13 +793,9 @@ class AccountingProvider < Orb::Internal::Type::BaseModel required :provider_type, enum: -> { Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType } - # @!parse - # # @param external_provider_id [String, nil] - # # @param provider_type [Symbol, Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType] - # # - # def initialize(external_provider_id:, provider_type:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(external_provider_id:, provider_type:) + # @param external_provider_id [String, nil] + # @param provider_type [Symbol, Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType] # @see Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider#provider_type module ProviderType @@ -844,11 +804,8 @@ module ProviderType QUICKBOOKS = :quickbooks NETSUITE = :netsuite - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -860,12 +817,8 @@ class ReportingConfiguration < Orb::Internal::Type::BaseModel # @return [Boolean] required :exempt, Orb::Internal::Type::Boolean - # @!parse - # # @param exempt [Boolean] - # # - # def initialize(exempt:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(exempt:) + # @param exempt [Boolean] end end end diff --git a/lib/orb/models/customer_create_params.rb b/lib/orb/models/customer_create_params.rb index d239bc23..3c81ddb9 100644 --- a/lib/orb/models/customer_create_params.rb +++ b/lib/orb/models/customer_create_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Customers#create class CustomerCreateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute email @@ -233,53 +232,57 @@ class CustomerCreateParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :timezone, String, nil?: true - # @!parse - # # @param email [String] - # # @param name [String] - # # @param accounting_sync_configuration [Orb::Models::CustomerCreateParams::AccountingSyncConfiguration, nil] - # # @param additional_emails [Array, nil] - # # @param auto_collection [Boolean, nil] - # # @param billing_address [Orb::Models::CustomerCreateParams::BillingAddress, nil] - # # @param currency [String, nil] - # # @param email_delivery [Boolean, nil] - # # @param external_customer_id [String, nil] - # # @param hierarchy [Orb::Models::CustomerCreateParams::Hierarchy, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param payment_provider [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil] - # # @param payment_provider_id [String, nil] - # # @param reporting_configuration [Orb::Models::CustomerCreateParams::ReportingConfiguration, nil] - # # @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil] - # # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration, nil] - # # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] - # # @param timezone [String, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # email:, - # name:, - # accounting_sync_configuration: nil, - # additional_emails: nil, - # auto_collection: nil, - # billing_address: nil, - # currency: nil, - # email_delivery: nil, - # external_customer_id: nil, - # hierarchy: nil, - # metadata: nil, - # payment_provider: nil, - # payment_provider_id: nil, - # reporting_configuration: nil, - # shipping_address: nil, - # tax_configuration: nil, - # tax_id: nil, - # timezone: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(email:, name:, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, timezone: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::CustomerCreateParams} for more details. + # + # @param email [String] A valid customer email, to be used for notifications. When Orb triggers payment + # ... + # + # @param name [String] The full name of the customer + # + # @param accounting_sync_configuration [Orb::Models::CustomerCreateParams::AccountingSyncConfiguration, nil] + # + # @param additional_emails [Array, nil] Additional email addresses for this customer. If populated, these email addresse + # ... + # + # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch + # ... + # + # @param billing_address [Orb::Models::CustomerCreateParams::BillingAddress, nil] + # + # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not + # ... + # + # @param email_delivery [Boolean, nil] + # + # @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst + # ... + # + # @param hierarchy [Orb::Models::CustomerCreateParams::Hierarchy, nil] The hierarchical relationships for this customer. + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param payment_provider [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe + # ... + # + # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i + # ... + # + # @param reporting_configuration [Orb::Models::CustomerCreateParams::ReportingConfiguration, nil] + # + # @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil] + # + # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration, nil] + # + # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad + # ... + # + # @param timezone [String, nil] A timezone identifier from the IANA timezone database, such as `"America/Los_Ang + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel # @!attribute accounting_providers @@ -294,13 +297,9 @@ class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel # @return [Boolean, nil] optional :excluded, Orb::Internal::Type::Boolean, nil?: true - # @!parse - # # @param accounting_providers [Array, nil] - # # @param excluded [Boolean, nil] - # # - # def initialize(accounting_providers: nil, excluded: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(accounting_providers: nil, excluded: nil) + # @param accounting_providers [Array, nil] + # @param excluded [Boolean, nil] class AccountingProvider < Orb::Internal::Type::BaseModel # @!attribute external_provider_id @@ -313,13 +312,9 @@ class AccountingProvider < Orb::Internal::Type::BaseModel # @return [String] required :provider_type, String - # @!parse - # # @param external_provider_id [String] - # # @param provider_type [String] - # # - # def initialize(external_provider_id:, provider_type:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(external_provider_id:, provider_type:) + # @param external_provider_id [String] + # @param provider_type [String] end end @@ -354,31 +349,23 @@ class BillingAddress < Orb::Internal::Type::BaseModel # @return [String, nil] optional :state, String, nil?: true - # @!parse - # # @param city [String, nil] - # # @param country [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) + # @param city [String, nil] + # @param country [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end class Hierarchy < Orb::Internal::Type::BaseModel - # @!attribute [r] child_customer_ids + # @!attribute child_customer_ids # A list of child customer IDs to add to the hierarchy. The desired child # customers must not already be part of another hierarchy. # # @return [Array, nil] optional :child_customer_ids, Orb::Internal::Type::ArrayOf[String] - # @!parse - # # @return [Array] - # attr_writer :child_customer_ids - # @!attribute parent_customer_id # The ID of the parent customer in the hierarchy. The desired parent customer must # not be a child of another customer. @@ -386,15 +373,17 @@ class Hierarchy < Orb::Internal::Type::BaseModel # @return [String, nil] optional :parent_customer_id, String, nil?: true - # @!parse - # # The hierarchical relationships for this customer. - # # - # # @param child_customer_ids [Array] - # # @param parent_customer_id [String, nil] - # # - # def initialize(child_customer_ids: nil, parent_customer_id: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(child_customer_ids: nil, parent_customer_id: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::CustomerCreateParams::Hierarchy} for more details. + # + # The hierarchical relationships for this customer. + # + # @param child_customer_ids [Array] A list of child customer IDs to add to the hierarchy. The desired child customer + # ... + # + # @param parent_customer_id [String, nil] The ID of the parent customer in the hierarchy. The desired parent customer must + # ... end # This is used for creating charges or invoices in an external system via Orb. @@ -409,11 +398,8 @@ module PaymentProvider STRIPE_INVOICE = :stripe_invoice NETSUITE = :netsuite - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class ReportingConfiguration < Orb::Internal::Type::BaseModel @@ -422,12 +408,8 @@ class ReportingConfiguration < Orb::Internal::Type::BaseModel # @return [Boolean] required :exempt, Orb::Internal::Type::Boolean - # @!parse - # # @param exempt [Boolean] - # # - # def initialize(exempt:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(exempt:) + # @param exempt [Boolean] end class ShippingAddress < Orb::Internal::Type::BaseModel @@ -461,17 +443,13 @@ class ShippingAddress < Orb::Internal::Type::BaseModel # @return [String, nil] optional :state, String, nil?: true - # @!parse - # # @param city [String, nil] - # # @param country [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) + # @param city [String, nil] + # @param country [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end module TaxConfiguration @@ -499,14 +477,10 @@ class NewAvalaraTaxConfiguration < Orb::Internal::Type::BaseModel # @return [String, nil] optional :tax_exemption_code, String, nil?: true - # @!parse - # # @param tax_exempt [Boolean] - # # @param tax_exemption_code [String, nil] - # # @param tax_provider [Symbol, :avalara] - # # - # def initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara) + # @param tax_exempt [Boolean] + # @param tax_exemption_code [String, nil] + # @param tax_provider [Symbol, :avalara] end class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel @@ -520,18 +494,13 @@ class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel # @return [Symbol, :taxjar] required :tax_provider, const: :taxjar - # @!parse - # # @param tax_exempt [Boolean] - # # @param tax_provider [Symbol, :taxjar] - # # - # def initialize(tax_exempt:, tax_provider: :taxjar, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tax_exempt:, tax_provider: :taxjar) + # @param tax_exempt [Boolean] + # @param tax_provider [Symbol, :taxjar] end - # @!parse - # # @return [Array(Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration)] end class TaxID < Orb::Internal::Type::BaseModel @@ -550,120 +519,116 @@ class TaxID < Orb::Internal::Type::BaseModel # @return [String] required :value, String - # @!parse - # # Tax IDs are commonly required to be displayed on customer invoices, which are - # # added to the headers of invoices. - # # - # # ### Supported Tax ID Countries and Types - # # - # # | Country | Type | Description | - # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # # | Andorra | `ad_nrt` | Andorran NRT Number | - # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # # | Austria | `eu_vat` | European VAT Number | - # # | Bahrain | `bh_vat` | Bahraini VAT Number | - # # | Belgium | `eu_vat` | European VAT Number | - # # | Bolivia | `bo_tin` | Bolivian Tax ID | - # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # # | Brazil | `br_cpf` | Brazilian CPF Number | - # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # # | Bulgaria | `eu_vat` | European VAT Number | - # # | Canada | `ca_bn` | Canadian BN | - # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # # | Chile | `cl_tin` | Chilean TIN | - # # | China | `cn_tin` | Chinese Tax ID | - # # | Colombia | `co_nit` | Colombian NIT Number | - # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # # | Croatia | `eu_vat` | European VAT Number | - # # | Cyprus | `eu_vat` | European VAT Number | - # # | Czech Republic | `eu_vat` | European VAT Number | - # # | Denmark | `eu_vat` | European VAT Number | - # # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # # | Estonia | `eu_vat` | European VAT Number | - # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # # | Finland | `eu_vat` | European VAT Number | - # # | France | `eu_vat` | European VAT Number | - # # | Georgia | `ge_vat` | Georgian VAT | - # # | Germany | `eu_vat` | European VAT Number | - # # | Greece | `eu_vat` | European VAT Number | - # # | Hong Kong | `hk_br` | Hong Kong BR Number | - # # | Hungary | `eu_vat` | European VAT Number | - # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # # | Iceland | `is_vat` | Icelandic VAT | - # # | India | `in_gst` | Indian GST Number | - # # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # # | Ireland | `eu_vat` | European VAT Number | - # # | Israel | `il_vat` | Israel VAT | - # # | Italy | `eu_vat` | European VAT Number | - # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # # | Latvia | `eu_vat` | European VAT Number | - # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # # | Lithuania | `eu_vat` | European VAT Number | - # # | Luxembourg | `eu_vat` | European VAT Number | - # # | Malaysia | `my_frp` | Malaysian FRP Number | - # # | Malaysia | `my_itn` | Malaysian ITN | - # # | Malaysia | `my_sst` | Malaysian SST Number | - # # | Malta | `eu_vat ` | European VAT Number | - # # | Mexico | `mx_rfc` | Mexican RFC Number | - # # | Netherlands | `eu_vat` | European VAT Number | - # # | New Zealand | `nz_gst` | New Zealand GST Number | - # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # # | Norway | `no_vat` | Norwegian VAT Number | - # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # # | Oman | `om_vat` | Omani VAT Number | - # # | Peru | `pe_ruc` | Peruvian RUC Number | - # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # # | Poland | `eu_vat` | European VAT Number | - # # | Portugal | `eu_vat` | European VAT Number | - # # | Romania | `eu_vat` | European VAT Number | - # # | Romania | `ro_tin` | Romanian Tax ID Number | - # # | Russia | `ru_inn` | Russian INN | - # # | Russia | `ru_kpp` | Russian KPP | - # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # # | Serbia | `rs_pib` | Serbian PIB Number | - # # | Singapore | `sg_gst` | Singaporean GST | - # # | Singapore | `sg_uen` | Singaporean UEN | - # # | Slovakia | `eu_vat` | European VAT Number | - # # | Slovenia | `eu_vat` | European VAT Number | - # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # # | South Africa | `za_vat` | South African VAT Number | - # # | South Korea | `kr_brn` | Korean BRN | - # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # # | Spain | `eu_vat` | European VAT Number | - # # | Sweden | `eu_vat` | European VAT Number | - # # | Switzerland | `ch_vat` | Switzerland VAT Number | - # # | Taiwan | `tw_vat` | Taiwanese VAT | - # # | Thailand | `th_vat` | Thai VAT | - # # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # # | Ukraine | `ua_vat` | Ukrainian VAT | - # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # # | United States | `us_ein` | United States EIN | - # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | - # # - # # @param country [Symbol, Orb::Models::CustomerCreateParams::TaxID::Country] - # # @param type [Symbol, Orb::Models::CustomerCreateParams::TaxID::Type] - # # @param value [String] - # # - # def initialize(country:, type:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(country:, type:, value:) + # Tax IDs are commonly required to be displayed on customer invoices, which are + # added to the headers of invoices. + # + # ### Supported Tax ID Countries and Types + # + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # + # @param country [Symbol, Orb::Models::CustomerCreateParams::TaxID::Country] + # @param type [Symbol, Orb::Models::CustomerCreateParams::TaxID::Type] + # @param value [String] # @see Orb::Models::CustomerCreateParams::TaxID#country module Country @@ -748,11 +713,8 @@ module Country VN = :VN ZA = :ZA - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::CustomerCreateParams::TaxID#type @@ -831,11 +793,8 @@ module Type VN_TIN = :vn_tin ZA_VAT = :za_vat - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customer_delete_params.rb b/lib/orb/models/customer_delete_params.rb index 2cb30477..ab4a040d 100644 --- a/lib/orb/models/customer_delete_params.rb +++ b/lib/orb/models/customer_delete_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Customers#delete class CustomerDeleteParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/customer_fetch_by_external_id_params.rb b/lib/orb/models/customer_fetch_by_external_id_params.rb index 154bc6f3..3755c690 100644 --- a/lib/orb/models/customer_fetch_by_external_id_params.rb +++ b/lib/orb/models/customer_fetch_by_external_id_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Customers#fetch_by_external_id class CustomerFetchByExternalIDParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/customer_fetch_params.rb b/lib/orb/models/customer_fetch_params.rb index 5e9a3785..5c16d739 100644 --- a/lib/orb/models/customer_fetch_params.rb +++ b/lib/orb/models/customer_fetch_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Customers#fetch class CustomerFetchParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/customer_list_params.rb b/lib/orb/models/customer_list_params.rb index ad4411e7..7b65daa6 100644 --- a/lib/orb/models/customer_list_params.rb +++ b/lib/orb/models/customer_list_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Customers#list class CustomerListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute created_at_gt @@ -35,39 +34,30 @@ class CustomerListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param created_at_gt [Time, nil] - # # @param created_at_gte [Time, nil] - # # @param created_at_lt [Time, nil] - # # @param created_at_lte [Time, nil] - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # created_at_gt: nil, - # created_at_gte: nil, - # created_at_lt: nil, - # created_at_lte: nil, - # cursor: nil, - # limit: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::CustomerListParams} for more details. + # + # @param created_at_gt [Time, nil] + # + # @param created_at_gte [Time, nil] + # + # @param created_at_lt [Time, nil] + # + # @param created_at_lte [Time, nil] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb b/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb index 1206e313..cef0da50 100644 --- a/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +++ b/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Customers#sync_payment_methods_from_gateway_by_external_customer_id class CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb b/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb index 102b8389..6c1bb699 100644 --- a/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +++ b/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Customers#sync_payment_methods_from_gateway class CustomerSyncPaymentMethodsFromGatewayParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/customer_update_by_external_id_params.rb b/lib/orb/models/customer_update_by_external_id_params.rb index d8562ebb..ea3a27d9 100644 --- a/lib/orb/models/customer_update_by_external_id_params.rb +++ b/lib/orb/models/customer_update_by_external_id_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Customers#update_by_external_id class CustomerUpdateByExternalIDParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute accounting_sync_configuration @@ -234,51 +233,53 @@ class CustomerUpdateByExternalIDParams < Orb::Internal::Type::BaseModel # @return [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] optional :tax_id, -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxID }, nil?: true - # @!parse - # # @param accounting_sync_configuration [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil] - # # @param additional_emails [Array, nil] - # # @param auto_collection [Boolean, nil] - # # @param billing_address [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil] - # # @param currency [String, nil] - # # @param email [String, nil] - # # @param email_delivery [Boolean, nil] - # # @param external_customer_id [String, nil] - # # @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param name [String, nil] - # # @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] - # # @param payment_provider_id [String, nil] - # # @param reporting_configuration [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil] - # # @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil] - # # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration, nil] - # # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # accounting_sync_configuration: nil, - # additional_emails: nil, - # auto_collection: nil, - # billing_address: nil, - # currency: nil, - # email: nil, - # email_delivery: nil, - # external_customer_id: nil, - # hierarchy: nil, - # metadata: nil, - # name: nil, - # payment_provider: nil, - # payment_provider_id: nil, - # reporting_configuration: nil, - # shipping_address: nil, - # tax_configuration: nil, - # tax_id: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::CustomerUpdateByExternalIDParams} for more details. + # + # @param accounting_sync_configuration [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil] + # + # @param additional_emails [Array, nil] Additional email addresses for this customer. If populated, these email addresse + # ... + # + # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch + # ... + # + # @param billing_address [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil] + # + # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not + # ... + # + # @param email [String, nil] A valid customer email, to be used for invoicing and notifications. + # + # @param email_delivery [Boolean, nil] + # + # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no + # ... + # + # @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer. + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param name [String, nil] The full name of the customer + # + # @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe + # ... + # + # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i + # ... + # + # @param reporting_configuration [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil] + # + # @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil] + # + # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration, nil] + # + # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel # @!attribute accounting_providers @@ -293,13 +294,9 @@ class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel # @return [Boolean, nil] optional :excluded, Orb::Internal::Type::Boolean, nil?: true - # @!parse - # # @param accounting_providers [Array, nil] - # # @param excluded [Boolean, nil] - # # - # def initialize(accounting_providers: nil, excluded: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(accounting_providers: nil, excluded: nil) + # @param accounting_providers [Array, nil] + # @param excluded [Boolean, nil] class AccountingProvider < Orb::Internal::Type::BaseModel # @!attribute external_provider_id @@ -312,13 +309,9 @@ class AccountingProvider < Orb::Internal::Type::BaseModel # @return [String] required :provider_type, String - # @!parse - # # @param external_provider_id [String] - # # @param provider_type [String] - # # - # def initialize(external_provider_id:, provider_type:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(external_provider_id:, provider_type:) + # @param external_provider_id [String] + # @param provider_type [String] end end @@ -353,31 +346,23 @@ class BillingAddress < Orb::Internal::Type::BaseModel # @return [String, nil] optional :state, String, nil?: true - # @!parse - # # @param city [String, nil] - # # @param country [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) + # @param city [String, nil] + # @param country [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end class Hierarchy < Orb::Internal::Type::BaseModel - # @!attribute [r] child_customer_ids + # @!attribute child_customer_ids # A list of child customer IDs to add to the hierarchy. The desired child # customers must not already be part of another hierarchy. # # @return [Array, nil] optional :child_customer_ids, Orb::Internal::Type::ArrayOf[String] - # @!parse - # # @return [Array] - # attr_writer :child_customer_ids - # @!attribute parent_customer_id # The ID of the parent customer in the hierarchy. The desired parent customer must # not be a child of another customer. @@ -385,15 +370,17 @@ class Hierarchy < Orb::Internal::Type::BaseModel # @return [String, nil] optional :parent_customer_id, String, nil?: true - # @!parse - # # The hierarchical relationships for this customer. - # # - # # @param child_customer_ids [Array] - # # @param parent_customer_id [String, nil] - # # - # def initialize(child_customer_ids: nil, parent_customer_id: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(child_customer_ids: nil, parent_customer_id: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy} for more details. + # + # The hierarchical relationships for this customer. + # + # @param child_customer_ids [Array] A list of child customer IDs to add to the hierarchy. The desired child customer + # ... + # + # @param parent_customer_id [String, nil] The ID of the parent customer in the hierarchy. The desired parent customer must + # ... end # This is used for creating charges or invoices in an external system via Orb. @@ -412,11 +399,8 @@ module PaymentProvider STRIPE_INVOICE = :stripe_invoice NETSUITE = :netsuite - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class ReportingConfiguration < Orb::Internal::Type::BaseModel @@ -425,12 +409,8 @@ class ReportingConfiguration < Orb::Internal::Type::BaseModel # @return [Boolean] required :exempt, Orb::Internal::Type::Boolean - # @!parse - # # @param exempt [Boolean] - # # - # def initialize(exempt:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(exempt:) + # @param exempt [Boolean] end class ShippingAddress < Orb::Internal::Type::BaseModel @@ -464,17 +444,13 @@ class ShippingAddress < Orb::Internal::Type::BaseModel # @return [String, nil] optional :state, String, nil?: true - # @!parse - # # @param city [String, nil] - # # @param country [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) + # @param city [String, nil] + # @param country [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end module TaxConfiguration @@ -504,14 +480,10 @@ class NewAvalaraTaxConfiguration < Orb::Internal::Type::BaseModel # @return [String, nil] optional :tax_exemption_code, String, nil?: true - # @!parse - # # @param tax_exempt [Boolean] - # # @param tax_exemption_code [String, nil] - # # @param tax_provider [Symbol, :avalara] - # # - # def initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara) + # @param tax_exempt [Boolean] + # @param tax_exemption_code [String, nil] + # @param tax_provider [Symbol, :avalara] end class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel @@ -525,18 +497,13 @@ class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel # @return [Symbol, :taxjar] required :tax_provider, const: :taxjar - # @!parse - # # @param tax_exempt [Boolean] - # # @param tax_provider [Symbol, :taxjar] - # # - # def initialize(tax_exempt:, tax_provider: :taxjar, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tax_exempt:, tax_provider: :taxjar) + # @param tax_exempt [Boolean] + # @param tax_provider [Symbol, :taxjar] end - # @!parse - # # @return [Array(Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration)] end class TaxID < Orb::Internal::Type::BaseModel @@ -555,120 +522,116 @@ class TaxID < Orb::Internal::Type::BaseModel # @return [String] required :value, String - # @!parse - # # Tax IDs are commonly required to be displayed on customer invoices, which are - # # added to the headers of invoices. - # # - # # ### Supported Tax ID Countries and Types - # # - # # | Country | Type | Description | - # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # # | Andorra | `ad_nrt` | Andorran NRT Number | - # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # # | Austria | `eu_vat` | European VAT Number | - # # | Bahrain | `bh_vat` | Bahraini VAT Number | - # # | Belgium | `eu_vat` | European VAT Number | - # # | Bolivia | `bo_tin` | Bolivian Tax ID | - # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # # | Brazil | `br_cpf` | Brazilian CPF Number | - # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # # | Bulgaria | `eu_vat` | European VAT Number | - # # | Canada | `ca_bn` | Canadian BN | - # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # # | Chile | `cl_tin` | Chilean TIN | - # # | China | `cn_tin` | Chinese Tax ID | - # # | Colombia | `co_nit` | Colombian NIT Number | - # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # # | Croatia | `eu_vat` | European VAT Number | - # # | Cyprus | `eu_vat` | European VAT Number | - # # | Czech Republic | `eu_vat` | European VAT Number | - # # | Denmark | `eu_vat` | European VAT Number | - # # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # # | Estonia | `eu_vat` | European VAT Number | - # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # # | Finland | `eu_vat` | European VAT Number | - # # | France | `eu_vat` | European VAT Number | - # # | Georgia | `ge_vat` | Georgian VAT | - # # | Germany | `eu_vat` | European VAT Number | - # # | Greece | `eu_vat` | European VAT Number | - # # | Hong Kong | `hk_br` | Hong Kong BR Number | - # # | Hungary | `eu_vat` | European VAT Number | - # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # # | Iceland | `is_vat` | Icelandic VAT | - # # | India | `in_gst` | Indian GST Number | - # # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # # | Ireland | `eu_vat` | European VAT Number | - # # | Israel | `il_vat` | Israel VAT | - # # | Italy | `eu_vat` | European VAT Number | - # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # # | Latvia | `eu_vat` | European VAT Number | - # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # # | Lithuania | `eu_vat` | European VAT Number | - # # | Luxembourg | `eu_vat` | European VAT Number | - # # | Malaysia | `my_frp` | Malaysian FRP Number | - # # | Malaysia | `my_itn` | Malaysian ITN | - # # | Malaysia | `my_sst` | Malaysian SST Number | - # # | Malta | `eu_vat ` | European VAT Number | - # # | Mexico | `mx_rfc` | Mexican RFC Number | - # # | Netherlands | `eu_vat` | European VAT Number | - # # | New Zealand | `nz_gst` | New Zealand GST Number | - # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # # | Norway | `no_vat` | Norwegian VAT Number | - # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # # | Oman | `om_vat` | Omani VAT Number | - # # | Peru | `pe_ruc` | Peruvian RUC Number | - # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # # | Poland | `eu_vat` | European VAT Number | - # # | Portugal | `eu_vat` | European VAT Number | - # # | Romania | `eu_vat` | European VAT Number | - # # | Romania | `ro_tin` | Romanian Tax ID Number | - # # | Russia | `ru_inn` | Russian INN | - # # | Russia | `ru_kpp` | Russian KPP | - # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # # | Serbia | `rs_pib` | Serbian PIB Number | - # # | Singapore | `sg_gst` | Singaporean GST | - # # | Singapore | `sg_uen` | Singaporean UEN | - # # | Slovakia | `eu_vat` | European VAT Number | - # # | Slovenia | `eu_vat` | European VAT Number | - # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # # | South Africa | `za_vat` | South African VAT Number | - # # | South Korea | `kr_brn` | Korean BRN | - # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # # | Spain | `eu_vat` | European VAT Number | - # # | Sweden | `eu_vat` | European VAT Number | - # # | Switzerland | `ch_vat` | Switzerland VAT Number | - # # | Taiwan | `tw_vat` | Taiwanese VAT | - # # | Thailand | `th_vat` | Thai VAT | - # # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # # | Ukraine | `ua_vat` | Ukrainian VAT | - # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # # | United States | `us_ein` | United States EIN | - # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | - # # - # # @param country [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country] - # # @param type [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type] - # # @param value [String] - # # - # def initialize(country:, type:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(country:, type:, value:) + # Tax IDs are commonly required to be displayed on customer invoices, which are + # added to the headers of invoices. + # + # ### Supported Tax ID Countries and Types + # + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # + # @param country [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country] + # @param type [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type] + # @param value [String] # @see Orb::Models::CustomerUpdateByExternalIDParams::TaxID#country module Country @@ -753,11 +716,8 @@ module Country VN = :VN ZA = :ZA - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::CustomerUpdateByExternalIDParams::TaxID#type @@ -836,11 +796,8 @@ module Type VN_TIN = :vn_tin ZA_VAT = :za_vat - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customer_update_params.rb b/lib/orb/models/customer_update_params.rb index e23fb54b..72ed7491 100644 --- a/lib/orb/models/customer_update_params.rb +++ b/lib/orb/models/customer_update_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Customers#update class CustomerUpdateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute accounting_sync_configuration @@ -226,51 +225,53 @@ class CustomerUpdateParams < Orb::Internal::Type::BaseModel # @return [Orb::Models::CustomerUpdateParams::TaxID, nil] optional :tax_id, -> { Orb::Models::CustomerUpdateParams::TaxID }, nil?: true - # @!parse - # # @param accounting_sync_configuration [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil] - # # @param additional_emails [Array, nil] - # # @param auto_collection [Boolean, nil] - # # @param billing_address [Orb::Models::CustomerUpdateParams::BillingAddress, nil] - # # @param currency [String, nil] - # # @param email [String, nil] - # # @param email_delivery [Boolean, nil] - # # @param external_customer_id [String, nil] - # # @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param name [String, nil] - # # @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil] - # # @param payment_provider_id [String, nil] - # # @param reporting_configuration [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil] - # # @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil] - # # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration, nil] - # # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # accounting_sync_configuration: nil, - # additional_emails: nil, - # auto_collection: nil, - # billing_address: nil, - # currency: nil, - # email: nil, - # email_delivery: nil, - # external_customer_id: nil, - # hierarchy: nil, - # metadata: nil, - # name: nil, - # payment_provider: nil, - # payment_provider_id: nil, - # reporting_configuration: nil, - # shipping_address: nil, - # tax_configuration: nil, - # tax_id: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::CustomerUpdateParams} for more details. + # + # @param accounting_sync_configuration [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil] + # + # @param additional_emails [Array, nil] Additional email addresses for this customer. If populated, these email addresse + # ... + # + # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch + # ... + # + # @param billing_address [Orb::Models::CustomerUpdateParams::BillingAddress, nil] + # + # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not + # ... + # + # @param email [String, nil] A valid customer email, to be used for invoicing and notifications. + # + # @param email_delivery [Boolean, nil] + # + # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no + # ... + # + # @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer. + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param name [String, nil] The full name of the customer + # + # @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe + # ... + # + # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i + # ... + # + # @param reporting_configuration [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil] + # + # @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil] + # + # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration, nil] + # + # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel # @!attribute accounting_providers @@ -285,13 +286,9 @@ class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel # @return [Boolean, nil] optional :excluded, Orb::Internal::Type::Boolean, nil?: true - # @!parse - # # @param accounting_providers [Array, nil] - # # @param excluded [Boolean, nil] - # # - # def initialize(accounting_providers: nil, excluded: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(accounting_providers: nil, excluded: nil) + # @param accounting_providers [Array, nil] + # @param excluded [Boolean, nil] class AccountingProvider < Orb::Internal::Type::BaseModel # @!attribute external_provider_id @@ -304,13 +301,9 @@ class AccountingProvider < Orb::Internal::Type::BaseModel # @return [String] required :provider_type, String - # @!parse - # # @param external_provider_id [String] - # # @param provider_type [String] - # # - # def initialize(external_provider_id:, provider_type:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(external_provider_id:, provider_type:) + # @param external_provider_id [String] + # @param provider_type [String] end end @@ -345,31 +338,23 @@ class BillingAddress < Orb::Internal::Type::BaseModel # @return [String, nil] optional :state, String, nil?: true - # @!parse - # # @param city [String, nil] - # # @param country [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) + # @param city [String, nil] + # @param country [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end class Hierarchy < Orb::Internal::Type::BaseModel - # @!attribute [r] child_customer_ids + # @!attribute child_customer_ids # A list of child customer IDs to add to the hierarchy. The desired child # customers must not already be part of another hierarchy. # # @return [Array, nil] optional :child_customer_ids, Orb::Internal::Type::ArrayOf[String] - # @!parse - # # @return [Array] - # attr_writer :child_customer_ids - # @!attribute parent_customer_id # The ID of the parent customer in the hierarchy. The desired parent customer must # not be a child of another customer. @@ -377,15 +362,17 @@ class Hierarchy < Orb::Internal::Type::BaseModel # @return [String, nil] optional :parent_customer_id, String, nil?: true - # @!parse - # # The hierarchical relationships for this customer. - # # - # # @param child_customer_ids [Array] - # # @param parent_customer_id [String, nil] - # # - # def initialize(child_customer_ids: nil, parent_customer_id: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(child_customer_ids: nil, parent_customer_id: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::CustomerUpdateParams::Hierarchy} for more details. + # + # The hierarchical relationships for this customer. + # + # @param child_customer_ids [Array] A list of child customer IDs to add to the hierarchy. The desired child customer + # ... + # + # @param parent_customer_id [String, nil] The ID of the parent customer in the hierarchy. The desired parent customer must + # ... end # This is used for creating charges or invoices in an external system via Orb. @@ -404,11 +391,8 @@ module PaymentProvider STRIPE_INVOICE = :stripe_invoice NETSUITE = :netsuite - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class ReportingConfiguration < Orb::Internal::Type::BaseModel @@ -417,12 +401,8 @@ class ReportingConfiguration < Orb::Internal::Type::BaseModel # @return [Boolean] required :exempt, Orb::Internal::Type::Boolean - # @!parse - # # @param exempt [Boolean] - # # - # def initialize(exempt:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(exempt:) + # @param exempt [Boolean] end class ShippingAddress < Orb::Internal::Type::BaseModel @@ -456,17 +436,13 @@ class ShippingAddress < Orb::Internal::Type::BaseModel # @return [String, nil] optional :state, String, nil?: true - # @!parse - # # @param city [String, nil] - # # @param country [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) + # @param city [String, nil] + # @param country [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end module TaxConfiguration @@ -494,14 +470,10 @@ class NewAvalaraTaxConfiguration < Orb::Internal::Type::BaseModel # @return [String, nil] optional :tax_exemption_code, String, nil?: true - # @!parse - # # @param tax_exempt [Boolean] - # # @param tax_exemption_code [String, nil] - # # @param tax_provider [Symbol, :avalara] - # # - # def initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara) + # @param tax_exempt [Boolean] + # @param tax_exemption_code [String, nil] + # @param tax_provider [Symbol, :avalara] end class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel @@ -515,18 +487,13 @@ class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel # @return [Symbol, :taxjar] required :tax_provider, const: :taxjar - # @!parse - # # @param tax_exempt [Boolean] - # # @param tax_provider [Symbol, :taxjar] - # # - # def initialize(tax_exempt:, tax_provider: :taxjar, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tax_exempt:, tax_provider: :taxjar) + # @param tax_exempt [Boolean] + # @param tax_provider [Symbol, :taxjar] end - # @!parse - # # @return [Array(Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration)] end class TaxID < Orb::Internal::Type::BaseModel @@ -545,120 +512,116 @@ class TaxID < Orb::Internal::Type::BaseModel # @return [String] required :value, String - # @!parse - # # Tax IDs are commonly required to be displayed on customer invoices, which are - # # added to the headers of invoices. - # # - # # ### Supported Tax ID Countries and Types - # # - # # | Country | Type | Description | - # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # # | Andorra | `ad_nrt` | Andorran NRT Number | - # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # # | Austria | `eu_vat` | European VAT Number | - # # | Bahrain | `bh_vat` | Bahraini VAT Number | - # # | Belgium | `eu_vat` | European VAT Number | - # # | Bolivia | `bo_tin` | Bolivian Tax ID | - # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # # | Brazil | `br_cpf` | Brazilian CPF Number | - # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # # | Bulgaria | `eu_vat` | European VAT Number | - # # | Canada | `ca_bn` | Canadian BN | - # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # # | Chile | `cl_tin` | Chilean TIN | - # # | China | `cn_tin` | Chinese Tax ID | - # # | Colombia | `co_nit` | Colombian NIT Number | - # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # # | Croatia | `eu_vat` | European VAT Number | - # # | Cyprus | `eu_vat` | European VAT Number | - # # | Czech Republic | `eu_vat` | European VAT Number | - # # | Denmark | `eu_vat` | European VAT Number | - # # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # # | Estonia | `eu_vat` | European VAT Number | - # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # # | Finland | `eu_vat` | European VAT Number | - # # | France | `eu_vat` | European VAT Number | - # # | Georgia | `ge_vat` | Georgian VAT | - # # | Germany | `eu_vat` | European VAT Number | - # # | Greece | `eu_vat` | European VAT Number | - # # | Hong Kong | `hk_br` | Hong Kong BR Number | - # # | Hungary | `eu_vat` | European VAT Number | - # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # # | Iceland | `is_vat` | Icelandic VAT | - # # | India | `in_gst` | Indian GST Number | - # # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # # | Ireland | `eu_vat` | European VAT Number | - # # | Israel | `il_vat` | Israel VAT | - # # | Italy | `eu_vat` | European VAT Number | - # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # # | Latvia | `eu_vat` | European VAT Number | - # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # # | Lithuania | `eu_vat` | European VAT Number | - # # | Luxembourg | `eu_vat` | European VAT Number | - # # | Malaysia | `my_frp` | Malaysian FRP Number | - # # | Malaysia | `my_itn` | Malaysian ITN | - # # | Malaysia | `my_sst` | Malaysian SST Number | - # # | Malta | `eu_vat ` | European VAT Number | - # # | Mexico | `mx_rfc` | Mexican RFC Number | - # # | Netherlands | `eu_vat` | European VAT Number | - # # | New Zealand | `nz_gst` | New Zealand GST Number | - # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # # | Norway | `no_vat` | Norwegian VAT Number | - # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # # | Oman | `om_vat` | Omani VAT Number | - # # | Peru | `pe_ruc` | Peruvian RUC Number | - # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # # | Poland | `eu_vat` | European VAT Number | - # # | Portugal | `eu_vat` | European VAT Number | - # # | Romania | `eu_vat` | European VAT Number | - # # | Romania | `ro_tin` | Romanian Tax ID Number | - # # | Russia | `ru_inn` | Russian INN | - # # | Russia | `ru_kpp` | Russian KPP | - # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # # | Serbia | `rs_pib` | Serbian PIB Number | - # # | Singapore | `sg_gst` | Singaporean GST | - # # | Singapore | `sg_uen` | Singaporean UEN | - # # | Slovakia | `eu_vat` | European VAT Number | - # # | Slovenia | `eu_vat` | European VAT Number | - # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # # | South Africa | `za_vat` | South African VAT Number | - # # | South Korea | `kr_brn` | Korean BRN | - # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # # | Spain | `eu_vat` | European VAT Number | - # # | Sweden | `eu_vat` | European VAT Number | - # # | Switzerland | `ch_vat` | Switzerland VAT Number | - # # | Taiwan | `tw_vat` | Taiwanese VAT | - # # | Thailand | `th_vat` | Thai VAT | - # # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # # | Ukraine | `ua_vat` | Ukrainian VAT | - # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # # | United States | `us_ein` | United States EIN | - # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | - # # - # # @param country [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country] - # # @param type [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type] - # # @param value [String] - # # - # def initialize(country:, type:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(country:, type:, value:) + # Tax IDs are commonly required to be displayed on customer invoices, which are + # added to the headers of invoices. + # + # ### Supported Tax ID Countries and Types + # + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # + # @param country [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country] + # @param type [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type] + # @param value [String] # @see Orb::Models::CustomerUpdateParams::TaxID#country module Country @@ -743,11 +706,8 @@ module Country VN = :VN ZA = :ZA - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::CustomerUpdateParams::TaxID#type @@ -826,11 +786,8 @@ module Type VN_TIN = :vn_tin ZA_VAT = :za_vat - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/balance_transaction_create_params.rb b/lib/orb/models/customers/balance_transaction_create_params.rb index 82dcef4e..d7b54341 100644 --- a/lib/orb/models/customers/balance_transaction_create_params.rb +++ b/lib/orb/models/customers/balance_transaction_create_params.rb @@ -5,8 +5,7 @@ module Models module Customers # @see Orb::Resources::Customers::BalanceTransactions#create class BalanceTransactionCreateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute amount @@ -25,15 +24,14 @@ class BalanceTransactionCreateParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :description, String, nil?: true - # @!parse - # # @param amount [String] - # # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type] - # # @param description [String, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(amount:, type:, description: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, type:, description: nil, request_options: {}) + # @param amount [String] + # + # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type] + # + # @param description [String, nil] An optional description that can be specified around this entry. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] module Type extend Orb::Internal::Type::Enum @@ -41,11 +39,8 @@ module Type INCREMENT = :increment DECREMENT = :decrement - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/balance_transaction_create_response.rb b/lib/orb/models/customers/balance_transaction_create_response.rb index e5954af4..dac883ca 100644 --- a/lib/orb/models/customers/balance_transaction_create_response.rb +++ b/lib/orb/models/customers/balance_transaction_create_response.rb @@ -65,35 +65,31 @@ class BalanceTransactionCreateResponse < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type] required :type, enum: -> { Orb::Models::Customers::BalanceTransactionCreateResponse::Type } - # @!parse - # # @param id [String] - # # @param action [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Action] - # # @param amount [String] - # # @param created_at [Time] - # # @param credit_note [Orb::Models::Customers::BalanceTransactionCreateResponse::CreditNote, nil] - # # @param description [String, nil] - # # @param ending_balance [String] - # # @param invoice [Orb::Models::Customers::BalanceTransactionCreateResponse::Invoice, nil] - # # @param starting_balance [String] - # # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type] - # # - # def initialize( - # id:, - # action:, - # amount:, - # created_at:, - # credit_note:, - # description:, - # ending_balance:, - # invoice:, - # starting_balance:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::BalanceTransactionCreateResponse} for more details. + # + # @param id [String] A unique id for this transaction. + # + # @param action [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Action] + # + # @param amount [String] The value of the amount changed in the transaction. + # + # @param created_at [Time] The creation time of this transaction. + # + # @param credit_note [Orb::Models::Customers::BalanceTransactionCreateResponse::CreditNote, nil] + # + # @param description [String, nil] An optional description provided for manual customer balance adjustments. + # + # @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome + # ... + # + # @param invoice [Orb::Models::Customers::BalanceTransactionCreateResponse::Invoice, nil] + # + # @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu + # ... + # + # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type] # @see Orb::Models::Customers::BalanceTransactionCreateResponse#action module Action @@ -109,11 +105,8 @@ module Action OVERPAYMENT_REFUND = :overpayment_refund EXTERNAL_PAYMENT = :external_payment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Customers::BalanceTransactionCreateResponse#credit_note @@ -124,12 +117,8 @@ class CreditNote < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] The id of the Credit note end # @see Orb::Models::Customers::BalanceTransactionCreateResponse#invoice @@ -140,12 +129,8 @@ class Invoice < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] The Invoice id end # @see Orb::Models::Customers::BalanceTransactionCreateResponse#type @@ -155,11 +140,8 @@ module Type INCREMENT = :increment DECREMENT = :decrement - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/balance_transaction_list_params.rb b/lib/orb/models/customers/balance_transaction_list_params.rb index 8b7b7e23..2296ea6c 100644 --- a/lib/orb/models/customers/balance_transaction_list_params.rb +++ b/lib/orb/models/customers/balance_transaction_list_params.rb @@ -5,8 +5,7 @@ module Models module Customers # @see Orb::Resources::Customers::BalanceTransactions#list class BalanceTransactionListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute cursor @@ -16,16 +15,12 @@ class BalanceTransactionListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - # @!attribute operation_time_gt # # @return [Time, nil] @@ -46,29 +41,24 @@ class BalanceTransactionListParams < Orb::Internal::Type::BaseModel # @return [Time, nil] optional :operation_time_lte, Time, nil?: true - # @!parse - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param operation_time_gt [Time, nil] - # # @param operation_time_gte [Time, nil] - # # @param operation_time_lt [Time, nil] - # # @param operation_time_lte [Time, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # cursor: nil, - # limit: nil, - # operation_time_gt: nil, - # operation_time_gte: nil, - # operation_time_lt: nil, - # operation_time_lte: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, limit: nil, operation_time_gt: nil, operation_time_gte: nil, operation_time_lt: nil, operation_time_lte: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::BalanceTransactionListParams} for more details. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param operation_time_gt [Time, nil] + # + # @param operation_time_gte [Time, nil] + # + # @param operation_time_lt [Time, nil] + # + # @param operation_time_lte [Time, nil] + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/customers/balance_transaction_list_response.rb b/lib/orb/models/customers/balance_transaction_list_response.rb index ac56f84e..4068d951 100644 --- a/lib/orb/models/customers/balance_transaction_list_response.rb +++ b/lib/orb/models/customers/balance_transaction_list_response.rb @@ -65,35 +65,31 @@ class BalanceTransactionListResponse < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type] required :type, enum: -> { Orb::Models::Customers::BalanceTransactionListResponse::Type } - # @!parse - # # @param id [String] - # # @param action [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Action] - # # @param amount [String] - # # @param created_at [Time] - # # @param credit_note [Orb::Models::Customers::BalanceTransactionListResponse::CreditNote, nil] - # # @param description [String, nil] - # # @param ending_balance [String] - # # @param invoice [Orb::Models::Customers::BalanceTransactionListResponse::Invoice, nil] - # # @param starting_balance [String] - # # @param type [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type] - # # - # def initialize( - # id:, - # action:, - # amount:, - # created_at:, - # credit_note:, - # description:, - # ending_balance:, - # invoice:, - # starting_balance:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::BalanceTransactionListResponse} for more details. + # + # @param id [String] A unique id for this transaction. + # + # @param action [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Action] + # + # @param amount [String] The value of the amount changed in the transaction. + # + # @param created_at [Time] The creation time of this transaction. + # + # @param credit_note [Orb::Models::Customers::BalanceTransactionListResponse::CreditNote, nil] + # + # @param description [String, nil] An optional description provided for manual customer balance adjustments. + # + # @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome + # ... + # + # @param invoice [Orb::Models::Customers::BalanceTransactionListResponse::Invoice, nil] + # + # @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu + # ... + # + # @param type [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type] # @see Orb::Models::Customers::BalanceTransactionListResponse#action module Action @@ -109,11 +105,8 @@ module Action OVERPAYMENT_REFUND = :overpayment_refund EXTERNAL_PAYMENT = :external_payment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Customers::BalanceTransactionListResponse#credit_note @@ -124,12 +117,8 @@ class CreditNote < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] The id of the Credit note end # @see Orb::Models::Customers::BalanceTransactionListResponse#invoice @@ -140,12 +129,8 @@ class Invoice < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] The Invoice id end # @see Orb::Models::Customers::BalanceTransactionListResponse#type @@ -155,11 +140,8 @@ module Type INCREMENT = :increment DECREMENT = :decrement - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/cost_list_by_external_id_params.rb b/lib/orb/models/customers/cost_list_by_external_id_params.rb index 306dd37a..4cf5c197 100644 --- a/lib/orb/models/customers/cost_list_by_external_id_params.rb +++ b/lib/orb/models/customers/cost_list_by_external_id_params.rb @@ -5,8 +5,7 @@ module Models module Customers # @see Orb::Resources::Customers::Costs#list_by_external_id class CostListByExternalIDParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute currency @@ -36,16 +35,20 @@ class CostListByExternalIDParams < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] optional :view_mode, enum: -> { Orb::Models::Customers::CostListByExternalIDParams::ViewMode }, nil?: true - # @!parse - # # @param currency [String, nil] - # # @param timeframe_end [Time, nil] - # # @param timeframe_start [Time, nil] - # # @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::CostListByExternalIDParams} for more details. + # + # @param currency [String, nil] The currency or custom pricing unit to use. + # + # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`. + # + # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`. + # + # @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] # Controls whether Orb returns cumulative costs since the start of the billing # period, or incremental day-by-day costs. If your customer has minimums or @@ -57,11 +60,8 @@ module ViewMode PERIODIC = :periodic CUMULATIVE = :cumulative - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/cost_list_by_external_id_response.rb b/lib/orb/models/customers/cost_list_by_external_id_response.rb index 5f5e209a..36cf501a 100644 --- a/lib/orb/models/customers/cost_list_by_external_id_response.rb +++ b/lib/orb/models/customers/cost_list_by_external_id_response.rb @@ -11,12 +11,8 @@ class CostListByExternalIDResponse < Orb::Internal::Type::BaseModel required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Customers::CostListByExternalIDResponse::Data] } - # @!parse - # # @param data [Array] - # # - # def initialize(data:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(data:) + # @param data [Array] class Data < Orb::Internal::Type::BaseModel # @!attribute per_price_costs @@ -47,16 +43,16 @@ class Data < Orb::Internal::Type::BaseModel # @return [String] required :total, String - # @!parse - # # @param per_price_costs [Array] - # # @param subtotal [String] - # # @param timeframe_end [Time] - # # @param timeframe_start [Time] - # # @param total [String] - # # - # def initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:) + # @param per_price_costs [Array] + # + # @param subtotal [String] Total costs for the timeframe, excluding any minimums and discounts. + # + # @param timeframe_end [Time] + # + # @param timeframe_start [Time] + # + # @param total [String] Total costs for the timeframe, including any minimums and discounts. class PerPriceCost < Orb::Internal::Type::BaseModel # @!attribute price @@ -89,16 +85,16 @@ class PerPriceCost < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :quantity, Float, nil?: true - # @!parse - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param price_id [String] - # # @param subtotal [String] - # # @param total [String] - # # @param quantity [Float, nil] - # # - # def initialize(price:, price_id:, subtotal:, total:, quantity: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(price:, price_id:, subtotal:, total:, quantity: nil) + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The price object + # + # @param price_id [String] The price the cost is associated with + # + # @param subtotal [String] Price's contributions for the timeframe, excluding any minimums and discounts. + # + # @param total [String] Price's contributions for the timeframe, including minimums and discounts. + # + # @param quantity [Float, nil] The price's quantity for the timeframe end end end diff --git a/lib/orb/models/customers/cost_list_params.rb b/lib/orb/models/customers/cost_list_params.rb index d602b340..c5c3c2b4 100644 --- a/lib/orb/models/customers/cost_list_params.rb +++ b/lib/orb/models/customers/cost_list_params.rb @@ -5,8 +5,7 @@ module Models module Customers # @see Orb::Resources::Customers::Costs#list class CostListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute currency @@ -36,16 +35,20 @@ class CostListParams < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] optional :view_mode, enum: -> { Orb::Models::Customers::CostListParams::ViewMode }, nil?: true - # @!parse - # # @param currency [String, nil] - # # @param timeframe_end [Time, nil] - # # @param timeframe_start [Time, nil] - # # @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::CostListParams} for more details. + # + # @param currency [String, nil] The currency or custom pricing unit to use. + # + # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`. + # + # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`. + # + # @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] # Controls whether Orb returns cumulative costs since the start of the billing # period, or incremental day-by-day costs. If your customer has minimums or @@ -57,11 +60,8 @@ module ViewMode PERIODIC = :periodic CUMULATIVE = :cumulative - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/cost_list_response.rb b/lib/orb/models/customers/cost_list_response.rb index 93e1dcad..879dba29 100644 --- a/lib/orb/models/customers/cost_list_response.rb +++ b/lib/orb/models/customers/cost_list_response.rb @@ -10,12 +10,8 @@ class CostListResponse < Orb::Internal::Type::BaseModel # @return [Array] required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Customers::CostListResponse::Data] } - # @!parse - # # @param data [Array] - # # - # def initialize(data:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(data:) + # @param data [Array] class Data < Orb::Internal::Type::BaseModel # @!attribute per_price_costs @@ -46,16 +42,16 @@ class Data < Orb::Internal::Type::BaseModel # @return [String] required :total, String - # @!parse - # # @param per_price_costs [Array] - # # @param subtotal [String] - # # @param timeframe_end [Time] - # # @param timeframe_start [Time] - # # @param total [String] - # # - # def initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:) + # @param per_price_costs [Array] + # + # @param subtotal [String] Total costs for the timeframe, excluding any minimums and discounts. + # + # @param timeframe_end [Time] + # + # @param timeframe_start [Time] + # + # @param total [String] Total costs for the timeframe, including any minimums and discounts. class PerPriceCost < Orb::Internal::Type::BaseModel # @!attribute price @@ -88,16 +84,16 @@ class PerPriceCost < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :quantity, Float, nil?: true - # @!parse - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param price_id [String] - # # @param subtotal [String] - # # @param total [String] - # # @param quantity [Float, nil] - # # - # def initialize(price:, price_id:, subtotal:, total:, quantity: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(price:, price_id:, subtotal:, total:, quantity: nil) + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The price object + # + # @param price_id [String] The price the cost is associated with + # + # @param subtotal [String] Price's contributions for the timeframe, excluding any minimums and discounts. + # + # @param total [String] Price's contributions for the timeframe, including minimums and discounts. + # + # @param quantity [Float, nil] The price's quantity for the timeframe end end end diff --git a/lib/orb/models/customers/credit_list_by_external_id_params.rb b/lib/orb/models/customers/credit_list_by_external_id_params.rb index f943e0fc..d70e00e4 100644 --- a/lib/orb/models/customers/credit_list_by_external_id_params.rb +++ b/lib/orb/models/customers/credit_list_by_external_id_params.rb @@ -5,8 +5,7 @@ module Models module Customers # @see Orb::Resources::Customers::Credits#list_by_external_id class CreditListByExternalIDParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute currency @@ -22,37 +21,34 @@ class CreditListByExternalIDParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] include_all_blocks + # @!attribute include_all_blocks # If set to True, all expired and depleted blocks, as well as active block will be # returned. # # @return [Boolean, nil] optional :include_all_blocks, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :include_all_blocks - - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param currency [String, nil] - # # @param cursor [String, nil] - # # @param include_all_blocks [Boolean] - # # @param limit [Integer] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::CreditListByExternalIDParams} for more details. + # + # @param currency [String, nil] The ledger currency or custom pricing unit to use. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/customers/credit_list_by_external_id_response.rb b/lib/orb/models/customers/credit_list_by_external_id_response.rb index 02d451a8..9e91017d 100644 --- a/lib/orb/models/customers/credit_list_by_external_id_response.rb +++ b/lib/orb/models/customers/credit_list_by_external_id_response.rb @@ -40,18 +40,14 @@ class CreditListByExternalIDResponse < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status] required :status, enum: -> { Orb::Models::Customers::CreditListByExternalIDResponse::Status } - # @!parse - # # @param id [String] - # # @param balance [Float] - # # @param effective_date [Time, nil] - # # @param expiry_date [Time, nil] - # # @param maximum_initial_balance [Float, nil] - # # @param per_unit_cost_basis [String, nil] - # # @param status [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status] - # # - # def initialize(id:, balance:, effective_date:, expiry_date:, maximum_initial_balance:, per_unit_cost_basis:, status:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, balance:, effective_date:, expiry_date:, maximum_initial_balance:, per_unit_cost_basis:, status:) + # @param id [String] + # @param balance [Float] + # @param effective_date [Time, nil] + # @param expiry_date [Time, nil] + # @param maximum_initial_balance [Float, nil] + # @param per_unit_cost_basis [String, nil] + # @param status [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status] # @see Orb::Models::Customers::CreditListByExternalIDResponse#status module Status @@ -60,11 +56,8 @@ module Status ACTIVE = :active PENDING_PAYMENT = :pending_payment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/credit_list_params.rb b/lib/orb/models/customers/credit_list_params.rb index 0fc64173..0455866a 100644 --- a/lib/orb/models/customers/credit_list_params.rb +++ b/lib/orb/models/customers/credit_list_params.rb @@ -5,8 +5,7 @@ module Models module Customers # @see Orb::Resources::Customers::Credits#list class CreditListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute currency @@ -22,37 +21,34 @@ class CreditListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] include_all_blocks + # @!attribute include_all_blocks # If set to True, all expired and depleted blocks, as well as active block will be # returned. # # @return [Boolean, nil] optional :include_all_blocks, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :include_all_blocks - - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param currency [String, nil] - # # @param cursor [String, nil] - # # @param include_all_blocks [Boolean] - # # @param limit [Integer] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::CreditListParams} for more details. + # + # @param currency [String, nil] The ledger currency or custom pricing unit to use. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/customers/credit_list_response.rb b/lib/orb/models/customers/credit_list_response.rb index 3ceb404f..0f67c916 100644 --- a/lib/orb/models/customers/credit_list_response.rb +++ b/lib/orb/models/customers/credit_list_response.rb @@ -40,18 +40,14 @@ class CreditListResponse < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::Customers::CreditListResponse::Status] required :status, enum: -> { Orb::Models::Customers::CreditListResponse::Status } - # @!parse - # # @param id [String] - # # @param balance [Float] - # # @param effective_date [Time, nil] - # # @param expiry_date [Time, nil] - # # @param maximum_initial_balance [Float, nil] - # # @param per_unit_cost_basis [String, nil] - # # @param status [Symbol, Orb::Models::Customers::CreditListResponse::Status] - # # - # def initialize(id:, balance:, effective_date:, expiry_date:, maximum_initial_balance:, per_unit_cost_basis:, status:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, balance:, effective_date:, expiry_date:, maximum_initial_balance:, per_unit_cost_basis:, status:) + # @param id [String] + # @param balance [Float] + # @param effective_date [Time, nil] + # @param expiry_date [Time, nil] + # @param maximum_initial_balance [Float, nil] + # @param per_unit_cost_basis [String, nil] + # @param status [Symbol, Orb::Models::Customers::CreditListResponse::Status] # @see Orb::Models::Customers::CreditListResponse#status module Status @@ -60,11 +56,8 @@ module Status ACTIVE = :active PENDING_PAYMENT = :pending_payment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb b/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb index 9ec2ecfe..7b7e3b1c 100644 --- a/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +++ b/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb @@ -6,8 +6,7 @@ module Customers module Credits # @see Orb::Resources::Customers::Credits::Ledger#create_entry_by_external_id class LedgerCreateEntryByExternalIDParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute amount @@ -99,52 +98,52 @@ class LedgerCreateEntryByExternalIDParams < Orb::Internal::Type::BaseModel enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason }, nil?: true - # @!parse - # # @param amount [Float] - # # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType] - # # @param expiry_date [Time, nil] - # # @param target_expiry_date [Date] - # # @param block_id [String] - # # @param currency [String, nil] - # # @param description [String, nil] - # # @param effective_date [Time, nil] - # # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param per_unit_cost_basis [String, nil] - # # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # amount:, - # entry_type:, - # expiry_date:, - # target_expiry_date:, - # block_id:, - # currency: nil, - # description: nil, - # effective_date: nil, - # invoice_settings: nil, - # metadata: nil, - # per_unit_cost_basis: nil, - # void_reason: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams} for more + # details. + # + # @param amount [Float] The number of credits to effect. Note that this is required for increment, decre + # ... + # + # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType] + # + # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire + # + # @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot + # ... + # + # @param block_id [String] The ID of the block to reverse a decrement from. + # + # @param currency [String, nil] The currency or custom pricing unit to use for this ledger entry. If this is a r + # ... + # + # @param description [String, nil] Optional metadata that can be specified when adding ledger results via the API. + # ... + # + # @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai + # ... + # + # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur + # ... + # + # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] module EntryType extend Orb::Internal::Type::Enum AMENDMENT = :amendment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class InvoiceSettings < Orb::Internal::Type::BaseModel @@ -169,31 +168,33 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @return [String, nil] optional :memo, String, nil?: true - # @!attribute [r] require_successful_payment + # @!attribute require_successful_payment # If true, the new credit block will require that the corresponding invoice is # paid before it can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :require_successful_payment - - # @!parse - # # Passing `invoice_settings` automatically generates an invoice for the newly - # # added credits. If `invoice_settings` is passed, you must specify - # # per_unit_cost_basis, as the calculation of the invoice total is done on that - # # basis. - # # - # # @param auto_collection [Boolean] - # # @param net_terms [Integer] - # # @param memo [String, nil] - # # @param require_successful_payment [Boolean] - # # - # def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings} + # for more details. + # + # Passing `invoice_settings` automatically generates an invoice for the newly + # added credits. If `invoice_settings` is passed, you must specify + # per_unit_cost_basis, as the calculation of the invoice total is done on that + # basis. + # + # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav + # ... + # + # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d + # ... + # + # @param memo [String, nil] An optional memo to display on the invoice. + # + # @param require_successful_payment [Boolean] If true, the new credit block will require that the corresponding invoice is pai + # ... end # Can only be specified when `entry_type=void`. The reason for the void. @@ -202,11 +203,8 @@ module VoidReason REFUND = :refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb b/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb index a021c658..dfe1bbda 100644 --- a/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +++ b/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb @@ -107,41 +107,37 @@ class IncrementLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :increment] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # entry_type: :increment, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :increment) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :increment] # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -160,14 +156,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry#customer @@ -182,13 +174,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry#entry_status @@ -198,11 +186,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -294,47 +279,43 @@ class DecrementLedgerEntry < Orb::Internal::Type::BaseModel # @return [String, nil] optional :price_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param event_id [String, nil] - # # @param invoice_id [String, nil] - # # @param price_id [String, nil] - # # @param entry_type [Symbol, :decrement] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # event_id: nil, - # invoice_id: nil, - # price_id: nil, - # entry_type: :decrement, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, event_id: nil, invoice_id: nil, price_id: nil, entry_type: :decrement) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param event_id [String, nil] + # + # @param invoice_id [String, nil] + # + # @param price_id [String, nil] + # + # @param entry_type [Symbol, :decrement] # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -353,14 +334,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry#customer @@ -375,13 +352,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry#entry_status @@ -391,11 +364,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -477,43 +447,39 @@ class ExpirationChangeLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param new_block_expiry_date [Time, nil] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :expiration_change] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # new_block_expiry_date:, - # starting_balance:, - # entry_type: :expiration_change, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, entry_type: :expiration_change) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param new_block_expiry_date [Time, nil] + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :expiration_change] # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -532,14 +498,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry#customer @@ -554,13 +516,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry#entry_status @@ -570,11 +528,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -651,41 +606,37 @@ class CreditBlockExpiryLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :credit_block_expiry] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # entry_type: :credit_block_expiry, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :credit_block_expiry) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :credit_block_expiry] # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -704,14 +655,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry#customer @@ -726,13 +673,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry#entry_status @@ -742,11 +685,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -833,45 +773,41 @@ class VoidLedgerEntry < Orb::Internal::Type::BaseModel # @return [String, nil] required :void_reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param void_amount [Float] - # # @param void_reason [String, nil] - # # @param entry_type [Symbol, :void] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # void_amount:, - # void_reason:, - # entry_type: :void, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, void_amount:, void_reason:, entry_type: :void) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param void_amount [Float] + # + # @param void_reason [String, nil] + # + # @param entry_type [Symbol, :void] # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -890,14 +826,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry#customer @@ -912,13 +844,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry#entry_status @@ -928,11 +856,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1024,47 +949,43 @@ class VoidInitiatedLedgerEntry < Orb::Internal::Type::BaseModel # @return [String, nil] required :void_reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param new_block_expiry_date [Time] - # # @param starting_balance [Float] - # # @param void_amount [Float] - # # @param void_reason [String, nil] - # # @param entry_type [Symbol, :void_initiated] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # new_block_expiry_date:, - # starting_balance:, - # void_amount:, - # void_reason:, - # entry_type: :void_initiated, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, void_amount:, void_reason:, entry_type: :void_initiated) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param new_block_expiry_date [Time] + # + # @param starting_balance [Float] + # + # @param void_amount [Float] + # + # @param void_reason [String, nil] + # + # @param entry_type [Symbol, :void_initiated] # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -1083,14 +1004,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry#customer @@ -1105,13 +1022,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry#entry_status @@ -1121,11 +1034,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1202,41 +1112,37 @@ class AmendmentLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :amendment] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # entry_type: :amendment, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :amendment) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :amendment] # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -1255,14 +1161,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry#customer @@ -1277,13 +1179,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry#entry_status @@ -1293,17 +1191,13 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end - # @!parse - # # @return [Array(Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry)] end end end diff --git a/lib/orb/models/customers/credits/ledger_create_entry_params.rb b/lib/orb/models/customers/credits/ledger_create_entry_params.rb index 098d1631..0e221e96 100644 --- a/lib/orb/models/customers/credits/ledger_create_entry_params.rb +++ b/lib/orb/models/customers/credits/ledger_create_entry_params.rb @@ -6,8 +6,7 @@ module Customers module Credits # @see Orb::Resources::Customers::Credits::Ledger#create_entry class LedgerCreateEntryParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute amount @@ -98,52 +97,51 @@ class LedgerCreateEntryParams < Orb::Internal::Type::BaseModel enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason }, nil?: true - # @!parse - # # @param amount [Float] - # # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType] - # # @param expiry_date [Time, nil] - # # @param target_expiry_date [Date] - # # @param block_id [String] - # # @param currency [String, nil] - # # @param description [String, nil] - # # @param effective_date [Time, nil] - # # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param per_unit_cost_basis [String, nil] - # # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # amount:, - # entry_type:, - # expiry_date:, - # target_expiry_date:, - # block_id:, - # currency: nil, - # description: nil, - # effective_date: nil, - # invoice_settings: nil, - # metadata: nil, - # per_unit_cost_basis: nil, - # void_reason: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryParams} for more details. + # + # @param amount [Float] The number of credits to effect. Note that this is required for increment, decre + # ... + # + # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType] + # + # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire + # + # @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot + # ... + # + # @param block_id [String] The ID of the block to reverse a decrement from. + # + # @param currency [String, nil] The currency or custom pricing unit to use for this ledger entry. If this is a r + # ... + # + # @param description [String, nil] Optional metadata that can be specified when adding ledger results via the API. + # ... + # + # @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai + # ... + # + # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur + # ... + # + # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] module EntryType extend Orb::Internal::Type::Enum AMENDMENT = :amendment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class InvoiceSettings < Orb::Internal::Type::BaseModel @@ -168,31 +166,33 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @return [String, nil] optional :memo, String, nil?: true - # @!attribute [r] require_successful_payment + # @!attribute require_successful_payment # If true, the new credit block will require that the corresponding invoice is # paid before it can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :require_successful_payment - - # @!parse - # # Passing `invoice_settings` automatically generates an invoice for the newly - # # added credits. If `invoice_settings` is passed, you must specify - # # per_unit_cost_basis, as the calculation of the invoice total is done on that - # # basis. - # # - # # @param auto_collection [Boolean] - # # @param net_terms [Integer] - # # @param memo [String, nil] - # # @param require_successful_payment [Boolean] - # # - # def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings} for + # more details. + # + # Passing `invoice_settings` automatically generates an invoice for the newly + # added credits. If `invoice_settings` is passed, you must specify + # per_unit_cost_basis, as the calculation of the invoice total is done on that + # basis. + # + # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav + # ... + # + # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d + # ... + # + # @param memo [String, nil] An optional memo to display on the invoice. + # + # @param require_successful_payment [Boolean] If true, the new credit block will require that the corresponding invoice is pai + # ... end # Can only be specified when `entry_type=void`. The reason for the void. @@ -201,11 +201,8 @@ module VoidReason REFUND = :refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/credits/ledger_create_entry_response.rb b/lib/orb/models/customers/credits/ledger_create_entry_response.rb index 6ae6f6a4..36e7a30e 100644 --- a/lib/orb/models/customers/credits/ledger_create_entry_response.rb +++ b/lib/orb/models/customers/credits/ledger_create_entry_response.rb @@ -106,41 +106,37 @@ class IncrementLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :increment] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # entry_type: :increment, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :increment) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :increment] # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -159,14 +155,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry#customer @@ -181,13 +173,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry#entry_status @@ -197,11 +185,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -293,47 +278,43 @@ class DecrementLedgerEntry < Orb::Internal::Type::BaseModel # @return [String, nil] optional :price_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param event_id [String, nil] - # # @param invoice_id [String, nil] - # # @param price_id [String, nil] - # # @param entry_type [Symbol, :decrement] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # event_id: nil, - # invoice_id: nil, - # price_id: nil, - # entry_type: :decrement, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, event_id: nil, invoice_id: nil, price_id: nil, entry_type: :decrement) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param event_id [String, nil] + # + # @param invoice_id [String, nil] + # + # @param price_id [String, nil] + # + # @param entry_type [Symbol, :decrement] # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -352,14 +333,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry#customer @@ -374,13 +351,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry#entry_status @@ -390,11 +363,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -476,43 +446,39 @@ class ExpirationChangeLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param new_block_expiry_date [Time, nil] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :expiration_change] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # new_block_expiry_date:, - # starting_balance:, - # entry_type: :expiration_change, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, entry_type: :expiration_change) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param new_block_expiry_date [Time, nil] + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :expiration_change] # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -531,14 +497,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry#customer @@ -553,13 +515,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry#entry_status @@ -569,11 +527,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -650,41 +605,37 @@ class CreditBlockExpiryLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :credit_block_expiry] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # entry_type: :credit_block_expiry, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :credit_block_expiry) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :credit_block_expiry] # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -703,14 +654,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry#customer @@ -725,13 +672,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry#entry_status @@ -741,11 +684,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -832,45 +772,41 @@ class VoidLedgerEntry < Orb::Internal::Type::BaseModel # @return [String, nil] required :void_reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param void_amount [Float] - # # @param void_reason [String, nil] - # # @param entry_type [Symbol, :void] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # void_amount:, - # void_reason:, - # entry_type: :void, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, void_amount:, void_reason:, entry_type: :void) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param void_amount [Float] + # + # @param void_reason [String, nil] + # + # @param entry_type [Symbol, :void] # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -889,14 +825,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry#customer @@ -911,13 +843,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry#entry_status @@ -927,11 +855,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1023,47 +948,43 @@ class VoidInitiatedLedgerEntry < Orb::Internal::Type::BaseModel # @return [String, nil] required :void_reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param new_block_expiry_date [Time] - # # @param starting_balance [Float] - # # @param void_amount [Float] - # # @param void_reason [String, nil] - # # @param entry_type [Symbol, :void_initiated] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # new_block_expiry_date:, - # starting_balance:, - # void_amount:, - # void_reason:, - # entry_type: :void_initiated, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, void_amount:, void_reason:, entry_type: :void_initiated) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param new_block_expiry_date [Time] + # + # @param starting_balance [Float] + # + # @param void_amount [Float] + # + # @param void_reason [String, nil] + # + # @param entry_type [Symbol, :void_initiated] # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -1082,14 +1003,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry#customer @@ -1104,13 +1021,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry#entry_status @@ -1120,11 +1033,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1201,41 +1111,37 @@ class AmendmentLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :amendment] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # entry_type: :amendment, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :amendment) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :amendment] # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -1254,14 +1160,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry#customer @@ -1276,13 +1178,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry#entry_status @@ -1292,17 +1190,13 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end - # @!parse - # # @return [Array(Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry)] end end end diff --git a/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb b/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb index f6c753ce..5c363b2a 100644 --- a/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +++ b/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb @@ -6,8 +6,7 @@ module Customers module Credits # @see Orb::Resources::Customers::Credits::Ledger#list_by_external_id class LedgerListByExternalIDParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute created_at_gt @@ -57,52 +56,44 @@ class LedgerListByExternalIDParams < Orb::Internal::Type::BaseModel enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType }, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - # @!attribute minimum_amount # # @return [String, nil] optional :minimum_amount, String, nil?: true - # @!parse - # # @param created_at_gt [Time, nil] - # # @param created_at_gte [Time, nil] - # # @param created_at_lt [Time, nil] - # # @param created_at_lte [Time, nil] - # # @param currency [String, nil] - # # @param cursor [String, nil] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil] - # # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil] - # # @param limit [Integer] - # # @param minimum_amount [String, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # created_at_gt: nil, - # created_at_gte: nil, - # created_at_lt: nil, - # created_at_lte: nil, - # currency: nil, - # cursor: nil, - # entry_status: nil, - # entry_type: nil, - # limit: nil, - # minimum_amount: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListByExternalIDParams} for more + # details. + # + # @param created_at_gt [Time, nil] + # + # @param created_at_gte [Time, nil] + # + # @param created_at_lt [Time, nil] + # + # @param created_at_lte [Time, nil] + # + # @param currency [String, nil] The ledger currency or custom pricing unit to use. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil] + # + # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil] + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param minimum_amount [String, nil] + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] module EntryStatus extend Orb::Internal::Type::Enum @@ -110,11 +101,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end module EntryType @@ -128,11 +116,8 @@ module EntryType VOID_INITIATED = :void_initiated AMENDMENT = :amendment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb b/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb index 959fa38a..5981daf1 100644 --- a/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +++ b/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb @@ -106,41 +106,37 @@ class IncrementLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :increment] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # entry_type: :increment, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :increment) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :increment] # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -159,14 +155,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry#customer @@ -181,13 +173,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry#entry_status @@ -197,11 +185,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -293,47 +278,43 @@ class DecrementLedgerEntry < Orb::Internal::Type::BaseModel # @return [String, nil] optional :price_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param event_id [String, nil] - # # @param invoice_id [String, nil] - # # @param price_id [String, nil] - # # @param entry_type [Symbol, :decrement] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # event_id: nil, - # invoice_id: nil, - # price_id: nil, - # entry_type: :decrement, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, event_id: nil, invoice_id: nil, price_id: nil, entry_type: :decrement) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param event_id [String, nil] + # + # @param invoice_id [String, nil] + # + # @param price_id [String, nil] + # + # @param entry_type [Symbol, :decrement] # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -352,14 +333,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry#customer @@ -374,13 +351,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry#entry_status @@ -390,11 +363,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -476,43 +446,39 @@ class ExpirationChangeLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param new_block_expiry_date [Time, nil] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :expiration_change] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # new_block_expiry_date:, - # starting_balance:, - # entry_type: :expiration_change, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, entry_type: :expiration_change) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param new_block_expiry_date [Time, nil] + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :expiration_change] # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -531,14 +497,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry#customer @@ -553,13 +515,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry#entry_status @@ -569,11 +527,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -650,41 +605,37 @@ class CreditBlockExpiryLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :credit_block_expiry] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # entry_type: :credit_block_expiry, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :credit_block_expiry) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :credit_block_expiry] # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -703,14 +654,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry#customer @@ -725,13 +672,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry#entry_status @@ -741,11 +684,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -832,45 +772,41 @@ class VoidLedgerEntry < Orb::Internal::Type::BaseModel # @return [String, nil] required :void_reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param void_amount [Float] - # # @param void_reason [String, nil] - # # @param entry_type [Symbol, :void] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # void_amount:, - # void_reason:, - # entry_type: :void, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, void_amount:, void_reason:, entry_type: :void) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param void_amount [Float] + # + # @param void_reason [String, nil] + # + # @param entry_type [Symbol, :void] # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -889,14 +825,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry#customer @@ -911,13 +843,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry#entry_status @@ -927,11 +855,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1023,47 +948,43 @@ class VoidInitiatedLedgerEntry < Orb::Internal::Type::BaseModel # @return [String, nil] required :void_reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param new_block_expiry_date [Time] - # # @param starting_balance [Float] - # # @param void_amount [Float] - # # @param void_reason [String, nil] - # # @param entry_type [Symbol, :void_initiated] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # new_block_expiry_date:, - # starting_balance:, - # void_amount:, - # void_reason:, - # entry_type: :void_initiated, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, void_amount:, void_reason:, entry_type: :void_initiated) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param new_block_expiry_date [Time] + # + # @param starting_balance [Float] + # + # @param void_amount [Float] + # + # @param void_reason [String, nil] + # + # @param entry_type [Symbol, :void_initiated] # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -1082,14 +1003,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry#customer @@ -1104,13 +1021,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry#entry_status @@ -1120,11 +1033,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1201,41 +1111,37 @@ class AmendmentLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :amendment] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # entry_type: :amendment, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :amendment) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :amendment] # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -1254,14 +1160,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry#customer @@ -1276,13 +1178,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry#entry_status @@ -1292,17 +1190,13 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end - # @!parse - # # @return [Array(Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry)] end end end diff --git a/lib/orb/models/customers/credits/ledger_list_params.rb b/lib/orb/models/customers/credits/ledger_list_params.rb index bbfb713b..9ddb7839 100644 --- a/lib/orb/models/customers/credits/ledger_list_params.rb +++ b/lib/orb/models/customers/credits/ledger_list_params.rb @@ -6,8 +6,7 @@ module Customers module Credits # @see Orb::Resources::Customers::Credits::Ledger#list class LedgerListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute created_at_gt @@ -57,52 +56,43 @@ class LedgerListParams < Orb::Internal::Type::BaseModel enum: -> { Orb::Models::Customers::Credits::LedgerListParams::EntryType }, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - # @!attribute minimum_amount # # @return [String, nil] optional :minimum_amount, String, nil?: true - # @!parse - # # @param created_at_gt [Time, nil] - # # @param created_at_gte [Time, nil] - # # @param created_at_lt [Time, nil] - # # @param created_at_lte [Time, nil] - # # @param currency [String, nil] - # # @param cursor [String, nil] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus, nil] - # # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType, nil] - # # @param limit [Integer] - # # @param minimum_amount [String, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # created_at_gt: nil, - # created_at_gte: nil, - # created_at_lt: nil, - # created_at_lte: nil, - # currency: nil, - # cursor: nil, - # entry_status: nil, - # entry_type: nil, - # limit: nil, - # minimum_amount: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListParams} for more details. + # + # @param created_at_gt [Time, nil] + # + # @param created_at_gte [Time, nil] + # + # @param created_at_lt [Time, nil] + # + # @param created_at_lte [Time, nil] + # + # @param currency [String, nil] The ledger currency or custom pricing unit to use. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus, nil] + # + # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType, nil] + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param minimum_amount [String, nil] + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] module EntryStatus extend Orb::Internal::Type::Enum @@ -110,11 +100,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end module EntryType @@ -128,11 +115,8 @@ module EntryType VOID_INITIATED = :void_initiated AMENDMENT = :amendment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/credits/ledger_list_response.rb b/lib/orb/models/customers/credits/ledger_list_response.rb index f0779d40..8a4b49d1 100644 --- a/lib/orb/models/customers/credits/ledger_list_response.rb +++ b/lib/orb/models/customers/credits/ledger_list_response.rb @@ -103,41 +103,37 @@ class IncrementLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :increment] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # entry_type: :increment, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :increment) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry} for + # more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :increment] # @see Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -156,14 +152,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry#customer @@ -178,13 +170,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry#entry_status @@ -194,11 +182,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -290,47 +275,43 @@ class DecrementLedgerEntry < Orb::Internal::Type::BaseModel # @return [String, nil] optional :price_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param event_id [String, nil] - # # @param invoice_id [String, nil] - # # @param price_id [String, nil] - # # @param entry_type [Symbol, :decrement] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # event_id: nil, - # invoice_id: nil, - # price_id: nil, - # entry_type: :decrement, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, event_id: nil, invoice_id: nil, price_id: nil, entry_type: :decrement) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry} for + # more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param event_id [String, nil] + # + # @param invoice_id [String, nil] + # + # @param price_id [String, nil] + # + # @param entry_type [Symbol, :decrement] # @see Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -349,14 +330,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry#customer @@ -371,13 +348,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry#entry_status @@ -387,11 +360,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -473,43 +443,39 @@ class ExpirationChangeLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param new_block_expiry_date [Time, nil] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :expiration_change] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # new_block_expiry_date:, - # starting_balance:, - # entry_type: :expiration_change, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, entry_type: :expiration_change) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param new_block_expiry_date [Time, nil] + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :expiration_change] # @see Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -528,14 +494,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry#customer @@ -550,13 +512,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry#entry_status @@ -566,11 +524,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -647,41 +602,37 @@ class CreditBlockExpiryLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :credit_block_expiry] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # entry_type: :credit_block_expiry, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :credit_block_expiry) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :credit_block_expiry] # @see Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -700,14 +651,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry#customer @@ -722,13 +669,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry#entry_status @@ -738,11 +681,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -828,45 +768,41 @@ class VoidLedgerEntry < Orb::Internal::Type::BaseModel # @return [String, nil] required :void_reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param void_amount [Float] - # # @param void_reason [String, nil] - # # @param entry_type [Symbol, :void] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # void_amount:, - # void_reason:, - # entry_type: :void, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, void_amount:, void_reason:, entry_type: :void) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry} for more + # details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param void_amount [Float] + # + # @param void_reason [String, nil] + # + # @param entry_type [Symbol, :void] # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -885,14 +821,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry#customer @@ -907,13 +839,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry#entry_status @@ -923,11 +851,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1019,47 +944,43 @@ class VoidInitiatedLedgerEntry < Orb::Internal::Type::BaseModel # @return [String, nil] required :void_reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param new_block_expiry_date [Time] - # # @param starting_balance [Float] - # # @param void_amount [Float] - # # @param void_reason [String, nil] - # # @param entry_type [Symbol, :void_initiated] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # new_block_expiry_date:, - # starting_balance:, - # void_amount:, - # void_reason:, - # entry_type: :void_initiated, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, void_amount:, void_reason:, entry_type: :void_initiated) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry} + # for more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param new_block_expiry_date [Time] + # + # @param starting_balance [Float] + # + # @param void_amount [Float] + # + # @param void_reason [String, nil] + # + # @param entry_type [Symbol, :void_initiated] # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -1078,14 +999,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry#customer @@ -1100,13 +1017,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry#entry_status @@ -1116,11 +1029,8 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1197,41 +1107,37 @@ class AmendmentLedgerEntry < Orb::Internal::Type::BaseModel # @return [Float] required :starting_balance, Float - # @!parse - # # @param id [String] - # # @param amount [Float] - # # @param created_at [Time] - # # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::CreditBlock] - # # @param currency [String] - # # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::Customer] - # # @param description [String, nil] - # # @param ending_balance [Float] - # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::EntryStatus] - # # @param ledger_sequence_number [Integer] - # # @param metadata [Hash{Symbol=>String}] - # # @param starting_balance [Float] - # # @param entry_type [Symbol, :amendment] - # # - # def initialize( - # id:, - # amount:, - # created_at:, - # credit_block:, - # currency:, - # customer:, - # description:, - # ending_balance:, - # entry_status:, - # ledger_sequence_number:, - # metadata:, - # starting_balance:, - # entry_type: :amendment, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :amendment) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry} for + # more details. + # + # @param id [String] + # + # @param amount [Float] + # + # @param created_at [Time] + # + # @param credit_block [Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::CreditBlock] + # + # @param currency [String] + # + # @param customer [Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::Customer] + # + # @param description [String, nil] + # + # @param ending_balance [Float] + # + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::EntryStatus] + # + # @param ledger_sequence_number [Integer] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param starting_balance [Float] + # + # @param entry_type [Symbol, :amendment] # @see Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry#credit_block class CreditBlock < Orb::Internal::Type::BaseModel @@ -1250,14 +1156,10 @@ class CreditBlock < Orb::Internal::Type::BaseModel # @return [String, nil] required :per_unit_cost_basis, String, nil?: true - # @!parse - # # @param id [String] - # # @param expiry_date [Time, nil] - # # @param per_unit_cost_basis [String, nil] - # # - # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiry_date:, per_unit_cost_basis:) + # @param id [String] + # @param expiry_date [Time, nil] + # @param per_unit_cost_basis [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry#customer @@ -1272,13 +1174,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end # @see Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry#entry_status @@ -1288,17 +1186,13 @@ module EntryStatus COMMITTED = :committed PENDING = :pending - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end - # @!parse - # # @return [Array(Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry)] end end end diff --git a/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb b/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb index ba7702ca..79214b51 100644 --- a/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +++ b/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb @@ -6,8 +6,7 @@ module Customers module Credits # @see Orb::Resources::Customers::Credits::TopUps#create_by_external_id class TopUpCreateByExternalIDParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute amount @@ -65,33 +64,32 @@ class TopUpCreateByExternalIDParams < Orb::Internal::Type::BaseModel enum: -> { Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit }, nil?: true - # @!parse - # # @param amount [String] - # # @param currency [String] - # # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] - # # @param per_unit_cost_basis [String] - # # @param threshold [String] - # # @param active_from [Time, nil] - # # @param expires_after [Integer, nil] - # # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # amount:, - # currency:, - # invoice_settings:, - # per_unit_cost_basis:, - # threshold:, - # active_from: nil, - # expires_after: nil, - # expires_after_unit: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams} for more + # details. + # + # @param amount [String] The amount to increment when the threshold is reached. + # + # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo + # ... + # + # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] Settings for invoices generated by triggered top-ups. + # + # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit. + # + # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this + # ... + # + # @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i + # ... + # + # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it + # ... + # + # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] The unit of expires_after. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute auto_collection @@ -115,28 +113,30 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @return [String, nil] optional :memo, String, nil?: true - # @!attribute [r] require_successful_payment + # @!attribute require_successful_payment # If true, new credit blocks created by this top-up will require that the # corresponding invoice is paid before they can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :require_successful_payment - - # @!parse - # # Settings for invoices generated by triggered top-ups. - # # - # # @param auto_collection [Boolean] - # # @param net_terms [Integer] - # # @param memo [String, nil] - # # @param require_successful_payment [Boolean] - # # - # def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings} + # for more details. + # + # Settings for invoices generated by triggered top-ups. + # + # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav + # ... + # + # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d + # ... + # + # @param memo [String, nil] An optional memo to display on the invoice. + # + # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo + # ... end # The unit of expires_after. @@ -146,11 +146,8 @@ module ExpiresAfterUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb b/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb index 8c786271..da0d1b9d 100644 --- a/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +++ b/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb @@ -59,31 +59,29 @@ class TopUpCreateByExternalIDResponse < Orb::Internal::Type::BaseModel enum: -> { Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit }, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param currency [String] - # # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings] - # # @param per_unit_cost_basis [String] - # # @param threshold [String] - # # @param expires_after [Integer, nil] - # # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit, nil] - # # - # def initialize( - # id:, - # amount:, - # currency:, - # invoice_settings:, - # per_unit_cost_basis:, - # threshold:, - # expires_after: nil, - # expires_after_unit: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, expires_after: nil, expires_after_unit: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse} for more + # details. + # + # @param id [String] + # + # @param amount [String] The amount to increment when the threshold is reached. + # + # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo + # ... + # + # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups. + # + # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit. + # + # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this + # ... + # + # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it + # ... + # + # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit, nil] The unit of expires_after. # @see Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse#invoice_settings class InvoiceSettings < Orb::Internal::Type::BaseModel @@ -108,28 +106,30 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @return [String, nil] optional :memo, String, nil?: true - # @!attribute [r] require_successful_payment + # @!attribute require_successful_payment # If true, new credit blocks created by this top-up will require that the # corresponding invoice is paid before they can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :require_successful_payment - - # @!parse - # # Settings for invoices generated by triggered top-ups. - # # - # # @param auto_collection [Boolean] - # # @param net_terms [Integer] - # # @param memo [String, nil] - # # @param require_successful_payment [Boolean] - # # - # def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings} + # for more details. + # + # Settings for invoices generated by triggered top-ups. + # + # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav + # ... + # + # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d + # ... + # + # @param memo [String, nil] An optional memo to display on the invoice. + # + # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo + # ... end # The unit of expires_after. @@ -141,11 +141,8 @@ module ExpiresAfterUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/credits/top_up_create_params.rb b/lib/orb/models/customers/credits/top_up_create_params.rb index 47ad256d..700de6b6 100644 --- a/lib/orb/models/customers/credits/top_up_create_params.rb +++ b/lib/orb/models/customers/credits/top_up_create_params.rb @@ -6,8 +6,7 @@ module Customers module Credits # @see Orb::Resources::Customers::Credits::TopUps#create class TopUpCreateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute amount @@ -64,33 +63,31 @@ class TopUpCreateParams < Orb::Internal::Type::BaseModel enum: -> { Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit }, nil?: true - # @!parse - # # @param amount [String] - # # @param currency [String] - # # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings] - # # @param per_unit_cost_basis [String] - # # @param threshold [String] - # # @param active_from [Time, nil] - # # @param expires_after [Integer, nil] - # # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # amount:, - # currency:, - # invoice_settings:, - # per_unit_cost_basis:, - # threshold:, - # active_from: nil, - # expires_after: nil, - # expires_after_unit: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpCreateParams} for more details. + # + # @param amount [String] The amount to increment when the threshold is reached. + # + # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo + # ... + # + # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings] Settings for invoices generated by triggered top-ups. + # + # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit. + # + # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this + # ... + # + # @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i + # ... + # + # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it + # ... + # + # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] The unit of expires_after. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute auto_collection @@ -114,28 +111,30 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @return [String, nil] optional :memo, String, nil?: true - # @!attribute [r] require_successful_payment + # @!attribute require_successful_payment # If true, new credit blocks created by this top-up will require that the # corresponding invoice is paid before they can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :require_successful_payment - - # @!parse - # # Settings for invoices generated by triggered top-ups. - # # - # # @param auto_collection [Boolean] - # # @param net_terms [Integer] - # # @param memo [String, nil] - # # @param require_successful_payment [Boolean] - # # - # def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings} for more + # details. + # + # Settings for invoices generated by triggered top-ups. + # + # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav + # ... + # + # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d + # ... + # + # @param memo [String, nil] An optional memo to display on the invoice. + # + # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo + # ... end # The unit of expires_after. @@ -145,11 +144,8 @@ module ExpiresAfterUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/credits/top_up_create_response.rb b/lib/orb/models/customers/credits/top_up_create_response.rb index c58be05f..dd00ada3 100644 --- a/lib/orb/models/customers/credits/top_up_create_response.rb +++ b/lib/orb/models/customers/credits/top_up_create_response.rb @@ -58,31 +58,28 @@ class TopUpCreateResponse < Orb::Internal::Type::BaseModel enum: -> { Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit }, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param currency [String] - # # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateResponse::InvoiceSettings] - # # @param per_unit_cost_basis [String] - # # @param threshold [String] - # # @param expires_after [Integer, nil] - # # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit, nil] - # # - # def initialize( - # id:, - # amount:, - # currency:, - # invoice_settings:, - # per_unit_cost_basis:, - # threshold:, - # expires_after: nil, - # expires_after_unit: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, expires_after: nil, expires_after_unit: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpCreateResponse} for more details. + # + # @param id [String] + # + # @param amount [String] The amount to increment when the threshold is reached. + # + # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo + # ... + # + # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups. + # + # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit. + # + # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this + # ... + # + # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it + # ... + # + # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit, nil] The unit of expires_after. # @see Orb::Models::Customers::Credits::TopUpCreateResponse#invoice_settings class InvoiceSettings < Orb::Internal::Type::BaseModel @@ -107,28 +104,30 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @return [String, nil] optional :memo, String, nil?: true - # @!attribute [r] require_successful_payment + # @!attribute require_successful_payment # If true, new credit blocks created by this top-up will require that the # corresponding invoice is paid before they can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :require_successful_payment - - # @!parse - # # Settings for invoices generated by triggered top-ups. - # # - # # @param auto_collection [Boolean] - # # @param net_terms [Integer] - # # @param memo [String, nil] - # # @param require_successful_payment [Boolean] - # # - # def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpCreateResponse::InvoiceSettings} for more + # details. + # + # Settings for invoices generated by triggered top-ups. + # + # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav + # ... + # + # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d + # ... + # + # @param memo [String, nil] An optional memo to display on the invoice. + # + # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo + # ... end # The unit of expires_after. @@ -140,11 +139,8 @@ module ExpiresAfterUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb b/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb index 823862e5..59c032ff 100644 --- a/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +++ b/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb @@ -6,8 +6,7 @@ module Customers module Credits # @see Orb::Resources::Customers::Credits::TopUps#delete_by_external_id class TopUpDeleteByExternalIDParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute external_customer_id @@ -15,13 +14,9 @@ class TopUpDeleteByExternalIDParams < Orb::Internal::Type::BaseModel # @return [String] required :external_customer_id, String - # @!parse - # # @param external_customer_id [String] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(external_customer_id:, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(external_customer_id:, request_options: {}) + # @param external_customer_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/customers/credits/top_up_delete_params.rb b/lib/orb/models/customers/credits/top_up_delete_params.rb index 04702e68..d88c90a5 100644 --- a/lib/orb/models/customers/credits/top_up_delete_params.rb +++ b/lib/orb/models/customers/credits/top_up_delete_params.rb @@ -6,8 +6,7 @@ module Customers module Credits # @see Orb::Resources::Customers::Credits::TopUps#delete class TopUpDeleteParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute customer_id @@ -15,13 +14,9 @@ class TopUpDeleteParams < Orb::Internal::Type::BaseModel # @return [String] required :customer_id, String - # @!parse - # # @param customer_id [String] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(customer_id:, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(customer_id:, request_options: {}) + # @param customer_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb b/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb index dfd6f38b..d376fc24 100644 --- a/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +++ b/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb @@ -6,8 +6,7 @@ module Customers module Credits # @see Orb::Resources::Customers::Credits::TopUps#list_by_external_id class TopUpListByExternalIDParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute cursor @@ -17,24 +16,22 @@ class TopUpListByExternalIDParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, limit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpListByExternalIDParams} for more details. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb b/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb index 7f1d9902..8b57c2e9 100644 --- a/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +++ b/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb @@ -59,31 +59,29 @@ class TopUpListByExternalIDResponse < Orb::Internal::Type::BaseModel enum: -> { Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit }, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param currency [String] - # # @param invoice_settings [Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::InvoiceSettings] - # # @param per_unit_cost_basis [String] - # # @param threshold [String] - # # @param expires_after [Integer, nil] - # # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit, nil] - # # - # def initialize( - # id:, - # amount:, - # currency:, - # invoice_settings:, - # per_unit_cost_basis:, - # threshold:, - # expires_after: nil, - # expires_after_unit: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, expires_after: nil, expires_after_unit: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpListByExternalIDResponse} for more + # details. + # + # @param id [String] + # + # @param amount [String] The amount to increment when the threshold is reached. + # + # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo + # ... + # + # @param invoice_settings [Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups. + # + # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit. + # + # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this + # ... + # + # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it + # ... + # + # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit, nil] The unit of expires_after. # @see Orb::Models::Customers::Credits::TopUpListByExternalIDResponse#invoice_settings class InvoiceSettings < Orb::Internal::Type::BaseModel @@ -108,28 +106,30 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @return [String, nil] optional :memo, String, nil?: true - # @!attribute [r] require_successful_payment + # @!attribute require_successful_payment # If true, new credit blocks created by this top-up will require that the # corresponding invoice is paid before they can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :require_successful_payment - - # @!parse - # # Settings for invoices generated by triggered top-ups. - # # - # # @param auto_collection [Boolean] - # # @param net_terms [Integer] - # # @param memo [String, nil] - # # @param require_successful_payment [Boolean] - # # - # def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::InvoiceSettings} + # for more details. + # + # Settings for invoices generated by triggered top-ups. + # + # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav + # ... + # + # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d + # ... + # + # @param memo [String, nil] An optional memo to display on the invoice. + # + # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo + # ... end # The unit of expires_after. @@ -141,11 +141,8 @@ module ExpiresAfterUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/customers/credits/top_up_list_params.rb b/lib/orb/models/customers/credits/top_up_list_params.rb index 9b0153ab..49f5e7a0 100644 --- a/lib/orb/models/customers/credits/top_up_list_params.rb +++ b/lib/orb/models/customers/credits/top_up_list_params.rb @@ -6,8 +6,7 @@ module Customers module Credits # @see Orb::Resources::Customers::Credits::TopUps#list class TopUpListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute cursor @@ -17,24 +16,22 @@ class TopUpListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, limit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpListParams} for more details. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/customers/credits/top_up_list_response.rb b/lib/orb/models/customers/credits/top_up_list_response.rb index 32d868ab..2e92ca99 100644 --- a/lib/orb/models/customers/credits/top_up_list_response.rb +++ b/lib/orb/models/customers/credits/top_up_list_response.rb @@ -58,31 +58,28 @@ class TopUpListResponse < Orb::Internal::Type::BaseModel enum: -> { Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit }, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param currency [String] - # # @param invoice_settings [Orb::Models::Customers::Credits::TopUpListResponse::InvoiceSettings] - # # @param per_unit_cost_basis [String] - # # @param threshold [String] - # # @param expires_after [Integer, nil] - # # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit, nil] - # # - # def initialize( - # id:, - # amount:, - # currency:, - # invoice_settings:, - # per_unit_cost_basis:, - # threshold:, - # expires_after: nil, - # expires_after_unit: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, expires_after: nil, expires_after_unit: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpListResponse} for more details. + # + # @param id [String] + # + # @param amount [String] The amount to increment when the threshold is reached. + # + # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo + # ... + # + # @param invoice_settings [Orb::Models::Customers::Credits::TopUpListResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups. + # + # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit. + # + # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this + # ... + # + # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it + # ... + # + # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit, nil] The unit of expires_after. # @see Orb::Models::Customers::Credits::TopUpListResponse#invoice_settings class InvoiceSettings < Orb::Internal::Type::BaseModel @@ -107,28 +104,30 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @return [String, nil] optional :memo, String, nil?: true - # @!attribute [r] require_successful_payment + # @!attribute require_successful_payment # If true, new credit blocks created by this top-up will require that the # corresponding invoice is paid before they can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :require_successful_payment - - # @!parse - # # Settings for invoices generated by triggered top-ups. - # # - # # @param auto_collection [Boolean] - # # @param net_terms [Integer] - # # @param memo [String, nil] - # # @param require_successful_payment [Boolean] - # # - # def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpListResponse::InvoiceSettings} for more + # details. + # + # Settings for invoices generated by triggered top-ups. + # + # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav + # ... + # + # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d + # ... + # + # @param memo [String, nil] An optional memo to display on the invoice. + # + # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo + # ... end # The unit of expires_after. @@ -140,11 +139,8 @@ module ExpiresAfterUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/dimensional_price_group.rb b/lib/orb/models/dimensional_price_group.rb index 6e5c11ef..e149c7b2 100644 --- a/lib/orb/models/dimensional_price_group.rb +++ b/lib/orb/models/dimensional_price_group.rb @@ -44,21 +44,27 @@ class DimensionalPriceGroup < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # A dimensional price group is used to partition the result of a billable metric - # # by a set of dimensions. Prices in a price group must specify the parition used - # # to derive their usage. - # # - # # @param id [String] - # # @param billable_metric_id [String] - # # @param dimensions [Array] - # # @param external_dimensional_price_group_id [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param name [String] - # # - # def initialize(id:, billable_metric_id:, dimensions:, external_dimensional_price_group_id:, metadata:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric_id:, dimensions:, external_dimensional_price_group_id:, metadata:, name:) + # Some parameter documentations has been truncated, see + # {Orb::Models::DimensionalPriceGroup} for more details. + # + # A dimensional price group is used to partition the result of a billable metric + # by a set of dimensions. Prices in a price group must specify the parition used + # to derive their usage. + # + # @param id [String] + # + # @param billable_metric_id [String] The billable metric associated with this dimensional price group. All prices ass + # ... + # + # @param dimensions [Array] The dimensions that this dimensional price group is defined over + # + # @param external_dimensional_price_group_id [String, nil] An alias for the dimensional price group + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param name [String] The name of the dimensional price group end end end diff --git a/lib/orb/models/dimensional_price_group_create_params.rb b/lib/orb/models/dimensional_price_group_create_params.rb index 5a5f3c5b..b909b168 100644 --- a/lib/orb/models/dimensional_price_group_create_params.rb +++ b/lib/orb/models/dimensional_price_group_create_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::DimensionalPriceGroups#create class DimensionalPriceGroupCreateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute billable_metric_id @@ -37,27 +36,22 @@ class DimensionalPriceGroupCreateParams < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param billable_metric_id [String] - # # @param dimensions [Array] - # # @param name [String] - # # @param external_dimensional_price_group_id [String, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # billable_metric_id:, - # dimensions:, - # name:, - # external_dimensional_price_group_id: nil, - # metadata: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(billable_metric_id:, dimensions:, name:, external_dimensional_price_group_id: nil, metadata: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::DimensionalPriceGroupCreateParams} for more details. + # + # @param billable_metric_id [String] + # + # @param dimensions [Array] The set of keys (in order) used to disambiguate prices in the group. + # + # @param name [String] + # + # @param external_dimensional_price_group_id [String, nil] + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/dimensional_price_group_list_params.rb b/lib/orb/models/dimensional_price_group_list_params.rb index e7aa81b3..47aeafe8 100644 --- a/lib/orb/models/dimensional_price_group_list_params.rb +++ b/lib/orb/models/dimensional_price_group_list_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::DimensionalPriceGroups#list class DimensionalPriceGroupListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute cursor @@ -15,24 +14,22 @@ class DimensionalPriceGroupListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, limit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::DimensionalPriceGroupListParams} for more details. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/dimensional_price_group_retrieve_params.rb b/lib/orb/models/dimensional_price_group_retrieve_params.rb index 4280cf5e..fcbb4792 100644 --- a/lib/orb/models/dimensional_price_group_retrieve_params.rb +++ b/lib/orb/models/dimensional_price_group_retrieve_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::DimensionalPriceGroups#retrieve class DimensionalPriceGroupRetrieveParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/dimensional_price_groups.rb b/lib/orb/models/dimensional_price_groups.rb index db0ec03c..2b61caa0 100644 --- a/lib/orb/models/dimensional_price_groups.rb +++ b/lib/orb/models/dimensional_price_groups.rb @@ -13,13 +13,9 @@ class DimensionalPriceGroupsAPI < Orb::Internal::Type::BaseModel # @return [Orb::Models::PaginationMetadata] required :pagination_metadata, -> { Orb::Models::PaginationMetadata } - # @!parse - # # @param data [Array] - # # @param pagination_metadata [Orb::Models::PaginationMetadata] - # # - # def initialize(data:, pagination_metadata:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(data:, pagination_metadata:) + # @param data [Array] + # @param pagination_metadata [Orb::Models::PaginationMetadata] end end end diff --git a/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb b/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb index 6b460d1b..7277508a 100644 --- a/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +++ b/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb @@ -5,16 +5,11 @@ module Models module DimensionalPriceGroups # @see Orb::Resources::DimensionalPriceGroups::ExternalDimensionalPriceGroupID#retrieve class ExternalDimensionalPriceGroupIDRetrieveParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/discount.rb b/lib/orb/models/discount.rb index 5b787b38..c3e38def 100644 --- a/lib/orb/models/discount.rb +++ b/lib/orb/models/discount.rb @@ -15,9 +15,8 @@ module Discount variant :amount, -> { Orb::Models::AmountDiscount } - # @!parse - # # @return [Array(Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount)] end end end diff --git a/lib/orb/models/evaluate_price_group.rb b/lib/orb/models/evaluate_price_group.rb index 11aab8e4..7f12595f 100644 --- a/lib/orb/models/evaluate_price_group.rb +++ b/lib/orb/models/evaluate_price_group.rb @@ -22,14 +22,12 @@ class EvaluatePriceGroup < Orb::Internal::Type::BaseModel # @return [Float] required :quantity, Float - # @!parse - # # @param amount [String] - # # @param grouping_values [Array] - # # @param quantity [Float] - # # - # def initialize(amount:, grouping_values:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, grouping_values:, quantity:) + # @param amount [String] The price's output for the group + # + # @param grouping_values [Array] The values for the group in the order specified by `grouping_keys` + # + # @param quantity [Float] The price's usage quantity for the group module GroupingValue extend Orb::Internal::Type::Union @@ -40,9 +38,8 @@ module GroupingValue variant Orb::Internal::Type::Boolean - # @!parse - # # @return [Array(String, Float, Boolean)] - # def self.variants; end + # @!method self.variants + # @return [Array(String, Float, Boolean)] end end end diff --git a/lib/orb/models/event_deprecate_params.rb b/lib/orb/models/event_deprecate_params.rb index a968c531..73b8ee81 100644 --- a/lib/orb/models/event_deprecate_params.rb +++ b/lib/orb/models/event_deprecate_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Events#deprecate class EventDeprecateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/event_deprecate_response.rb b/lib/orb/models/event_deprecate_response.rb index 044484e6..d31b2523 100644 --- a/lib/orb/models/event_deprecate_response.rb +++ b/lib/orb/models/event_deprecate_response.rb @@ -10,12 +10,8 @@ class EventDeprecateResponse < Orb::Internal::Type::BaseModel # @return [String] required :deprecated, String - # @!parse - # # @param deprecated [String] - # # - # def initialize(deprecated:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(deprecated:) + # @param deprecated [String] event_id of the deprecated event, if successfully updated end end end diff --git a/lib/orb/models/event_ingest_params.rb b/lib/orb/models/event_ingest_params.rb index f340cef8..0837970b 100644 --- a/lib/orb/models/event_ingest_params.rb +++ b/lib/orb/models/event_ingest_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Events#ingest class EventIngestParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute events @@ -20,25 +19,24 @@ class EventIngestParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :backfill_id, String, nil?: true - # @!attribute [r] debug + # @!attribute debug # Flag to enable additional debug information in the endpoint response # # @return [Boolean, nil] optional :debug, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :debug - - # @!parse - # # @param events [Array] - # # @param backfill_id [String, nil] - # # @param debug [Boolean] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(events:, backfill_id: nil, debug: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(events:, backfill_id: nil, debug: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::EventIngestParams} for more details. + # + # @param events [Array] + # + # @param backfill_id [String, nil] If this ingestion request is part of a backfill, this parameter ties the ingeste + # ... + # + # @param debug [Boolean] Flag to enable additional debug information in the endpoint response + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] class Event < Orb::Internal::Type::BaseModel # @!attribute event_name @@ -83,17 +81,25 @@ class Event < Orb::Internal::Type::BaseModel # @return [String, nil] optional :external_customer_id, String, nil?: true - # @!parse - # # @param event_name [String] - # # @param idempotency_key [String] - # # @param properties [Object] - # # @param timestamp [Time] - # # @param customer_id [String, nil] - # # @param external_customer_id [String, nil] - # # - # def initialize(event_name:, idempotency_key:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(event_name:, idempotency_key:, properties:, timestamp:, customer_id: nil, external_customer_id: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::EventIngestParams::Event} for more details. + # + # @param event_name [String] A name to meaningfully identify the action or event type. + # + # @param idempotency_key [String] A unique value, generated by the client, that is used to de-duplicate events. Ex + # ... + # + # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo + # ... + # + # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen + # ... + # + # @param customer_id [String, nil] The Orb Customer identifier + # + # @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust + # ... end end end diff --git a/lib/orb/models/event_ingest_response.rb b/lib/orb/models/event_ingest_response.rb index 2321b477..a1dfd8da 100644 --- a/lib/orb/models/event_ingest_response.rb +++ b/lib/orb/models/event_ingest_response.rb @@ -19,13 +19,15 @@ class EventIngestResponse < Orb::Internal::Type::BaseModel # @return [Orb::Models::EventIngestResponse::Debug, nil] optional :debug, -> { Orb::Models::EventIngestResponse::Debug }, nil?: true - # @!parse - # # @param validation_failed [Array] - # # @param debug [Orb::Models::EventIngestResponse::Debug, nil] - # # - # def initialize(validation_failed:, debug: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(validation_failed:, debug: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::EventIngestResponse} for more details. + # + # @param validation_failed [Array] Contains all failing validation events. In the case of a 200, this array will al + # ... + # + # @param debug [Orb::Models::EventIngestResponse::Debug, nil] Optional debug information (only present when debug=true is passed to the endpoi + # ... class ValidationFailed < Orb::Internal::Type::BaseModel # @!attribute idempotency_key @@ -41,13 +43,14 @@ class ValidationFailed < Orb::Internal::Type::BaseModel # @return [Array] required :validation_errors, Orb::Internal::Type::ArrayOf[String] - # @!parse - # # @param idempotency_key [String] - # # @param validation_errors [Array] - # # - # def initialize(idempotency_key:, validation_errors:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(idempotency_key:, validation_errors:) + # Some parameter documentations has been truncated, see + # {Orb::Models::EventIngestResponse::ValidationFailed} for more details. + # + # @param idempotency_key [String] The passed idempotency_key corresponding to the validation_errors + # + # @param validation_errors [Array] An array of strings corresponding to validation failures for this idempotency_ke + # ... end # @see Orb::Models::EventIngestResponse#debug @@ -62,16 +65,12 @@ class Debug < Orb::Internal::Type::BaseModel # @return [Array] required :ingested, Orb::Internal::Type::ArrayOf[String] - # @!parse - # # Optional debug information (only present when debug=true is passed to the - # # endpoint). Contains ingested and duplicate event idempotency keys. - # # - # # @param duplicate [Array] - # # @param ingested [Array] - # # - # def initialize(duplicate:, ingested:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duplicate:, ingested:) + # Optional debug information (only present when debug=true is passed to the + # endpoint). Contains ingested and duplicate event idempotency keys. + # + # @param duplicate [Array] + # @param ingested [Array] end end end diff --git a/lib/orb/models/event_search_params.rb b/lib/orb/models/event_search_params.rb index 3104eed7..272d828a 100644 --- a/lib/orb/models/event_search_params.rb +++ b/lib/orb/models/event_search_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Events#search class EventSearchParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute event_ids @@ -31,15 +30,20 @@ class EventSearchParams < Orb::Internal::Type::BaseModel # @return [Time, nil] optional :timeframe_start, Time, nil?: true - # @!parse - # # @param event_ids [Array] - # # @param timeframe_end [Time, nil] - # # @param timeframe_start [Time, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::EventSearchParams} for more details. + # + # @param event_ids [Array] This is an explicit array of IDs to filter by. Note that an event's ID is the id + # ... + # + # @param timeframe_end [Time, nil] The end of the timeframe, exclusive, in which to search events. If not specified + # ... + # + # @param timeframe_start [Time, nil] The start of the timeframe, inclusive, in which to search events. If not specifi + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/event_search_response.rb b/lib/orb/models/event_search_response.rb index e4533d95..aaf250db 100644 --- a/lib/orb/models/event_search_response.rb +++ b/lib/orb/models/event_search_response.rb @@ -9,12 +9,8 @@ class EventSearchResponse < Orb::Internal::Type::BaseModel # @return [Array] required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Models::EventSearchResponse::Data] } - # @!parse - # # @param data [Array] - # # - # def initialize(data:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(data:) + # @param data [Array] class Data < Orb::Internal::Type::BaseModel # @!attribute id @@ -65,22 +61,31 @@ class Data < Orb::Internal::Type::BaseModel # @return [Time] required :timestamp, Time - # @!parse - # # The [Event](/core-concepts#event) resource represents a usage event that has - # # been created for a customer. Events are the core of Orb's usage-based billing - # # model, and are used to calculate the usage charges for a given billing period. - # # - # # @param id [String] - # # @param customer_id [String, nil] - # # @param deprecated [Boolean] - # # @param event_name [String] - # # @param external_customer_id [String, nil] - # # @param properties [Object] - # # @param timestamp [Time] - # # - # def initialize(id:, customer_id:, deprecated:, event_name:, external_customer_id:, properties:, timestamp:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, customer_id:, deprecated:, event_name:, external_customer_id:, properties:, timestamp:) + # Some parameter documentations has been truncated, see + # {Orb::Models::EventSearchResponse::Data} for more details. + # + # The [Event](/core-concepts#event) resource represents a usage event that has + # been created for a customer. Events are the core of Orb's usage-based billing + # model, and are used to calculate the usage charges for a given billing period. + # + # @param id [String] A unique value, generated by the client, that is used to de-duplicate events. Ex + # ... + # + # @param customer_id [String, nil] The Orb Customer identifier + # + # @param deprecated [Boolean] A boolean indicating whether the event is currently deprecated. + # + # @param event_name [String] A name to meaningfully identify the action or event type. + # + # @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust + # ... + # + # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo + # ... + # + # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen + # ... end end end diff --git a/lib/orb/models/event_update_params.rb b/lib/orb/models/event_update_params.rb index 5456d632..06549031 100644 --- a/lib/orb/models/event_update_params.rb +++ b/lib/orb/models/event_update_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Events#update class EventUpdateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute event_name @@ -42,17 +41,24 @@ class EventUpdateParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :external_customer_id, String, nil?: true - # @!parse - # # @param event_name [String] - # # @param properties [Object] - # # @param timestamp [Time] - # # @param customer_id [String, nil] - # # @param external_customer_id [String, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::EventUpdateParams} for more details. + # + # @param event_name [String] A name to meaningfully identify the action or event type. + # + # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo + # ... + # + # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen + # ... + # + # @param customer_id [String, nil] The Orb Customer identifier + # + # @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/event_update_response.rb b/lib/orb/models/event_update_response.rb index ab46b305..b59ae564 100644 --- a/lib/orb/models/event_update_response.rb +++ b/lib/orb/models/event_update_response.rb @@ -10,12 +10,8 @@ class EventUpdateResponse < Orb::Internal::Type::BaseModel # @return [String] required :amended, String - # @!parse - # # @param amended [String] - # # - # def initialize(amended:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amended:) + # @param amended [String] event_id of the amended event, if successfully ingested end end end diff --git a/lib/orb/models/events/backfill_close_params.rb b/lib/orb/models/events/backfill_close_params.rb index c485bf67..e2324a3e 100644 --- a/lib/orb/models/events/backfill_close_params.rb +++ b/lib/orb/models/events/backfill_close_params.rb @@ -5,16 +5,11 @@ module Models module Events # @see Orb::Resources::Events::Backfills#close class BackfillCloseParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/events/backfill_close_response.rb b/lib/orb/models/events/backfill_close_response.rb index ed749215..43dc81fd 100644 --- a/lib/orb/models/events/backfill_close_response.rb +++ b/lib/orb/models/events/backfill_close_response.rb @@ -73,40 +73,38 @@ class BackfillCloseResponse < Orb::Internal::Type::BaseModel # @return [String, nil] optional :deprecation_filter, String, nil?: true - # @!parse - # # A backfill represents an update to historical usage data, adding or replacing - # # events in a timeframe. - # # - # # @param id [String] - # # @param close_time [Time, nil] - # # @param created_at [Time] - # # @param customer_id [String, nil] - # # @param events_ingested [Integer] - # # @param replace_existing_events [Boolean] - # # @param reverted_at [Time, nil] - # # @param status [Symbol, Orb::Models::Events::BackfillCloseResponse::Status] - # # @param timeframe_end [Time] - # # @param timeframe_start [Time] - # # @param deprecation_filter [String, nil] - # # - # def initialize( - # id:, - # close_time:, - # created_at:, - # customer_id:, - # events_ingested:, - # replace_existing_events:, - # reverted_at:, - # status:, - # timeframe_end:, - # timeframe_start:, - # deprecation_filter: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Events::BackfillCloseResponse} for more details. + # + # A backfill represents an update to historical usage data, adding or replacing + # events in a timeframe. + # + # @param id [String] + # + # @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in + # ... + # + # @param created_at [Time] + # + # @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null` + # ... + # + # @param events_ingested [Integer] The number of events ingested in this backfill. + # + # @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the + # ... + # + # @param reverted_at [Time, nil] The time at which this backfill was reverted. + # + # @param status [Symbol, Orb::Models::Events::BackfillCloseResponse::Status] The status of the backfill. + # + # @param timeframe_end [Time] + # + # @param timeframe_start [Time] + # + # @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie + # ... # The status of the backfill. # @@ -119,11 +117,8 @@ module Status PENDING_REVERT = :pending_revert REVERTED = :reverted - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/events/backfill_create_params.rb b/lib/orb/models/events/backfill_create_params.rb index 1b0b5293..baa8fecd 100644 --- a/lib/orb/models/events/backfill_create_params.rb +++ b/lib/orb/models/events/backfill_create_params.rb @@ -5,8 +5,7 @@ module Models module Events # @see Orb::Resources::Events::Backfills#create class BackfillCreateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute timeframe_end @@ -55,42 +54,39 @@ class BackfillCreateParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :external_customer_id, String, nil?: true - # @!attribute [r] replace_existing_events + # @!attribute replace_existing_events # If true, replaces all existing events in the timeframe with the newly ingested # events. If false, adds the newly ingested events to the existing events. # # @return [Boolean, nil] optional :replace_existing_events, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :replace_existing_events - - # @!parse - # # @param timeframe_end [Time] - # # @param timeframe_start [Time] - # # @param close_time [Time, nil] - # # @param customer_id [String, nil] - # # @param deprecation_filter [String, nil] - # # @param external_customer_id [String, nil] - # # @param replace_existing_events [Boolean] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # timeframe_end:, - # timeframe_start:, - # close_time: nil, - # customer_id: nil, - # deprecation_filter: nil, - # external_customer_id: nil, - # replace_existing_events: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(timeframe_end:, timeframe_start:, close_time: nil, customer_id: nil, deprecation_filter: nil, external_customer_id: nil, replace_existing_events: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Events::BackfillCreateParams} for more details. + # + # @param timeframe_end [Time] The (exclusive) end of the usage timeframe affected by this backfill. By default + # ... + # + # @param timeframe_start [Time] The (inclusive) start of the usage timeframe affected by this backfill. By defau + # ... + # + # @param close_time [Time, nil] The time at which no more events will be accepted for this backfill. The backfil + # ... + # + # @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. Omitting + # ... + # + # @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie + # ... + # + # @param external_customer_id [String, nil] The external customer ID of the customer to which this backfill is scoped. Omitt + # ... + # + # @param replace_existing_events [Boolean] If true, replaces all existing events in the timeframe with the newly ingested e + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/events/backfill_create_response.rb b/lib/orb/models/events/backfill_create_response.rb index 9e3c8132..61f1551b 100644 --- a/lib/orb/models/events/backfill_create_response.rb +++ b/lib/orb/models/events/backfill_create_response.rb @@ -73,40 +73,38 @@ class BackfillCreateResponse < Orb::Internal::Type::BaseModel # @return [String, nil] optional :deprecation_filter, String, nil?: true - # @!parse - # # A backfill represents an update to historical usage data, adding or replacing - # # events in a timeframe. - # # - # # @param id [String] - # # @param close_time [Time, nil] - # # @param created_at [Time] - # # @param customer_id [String, nil] - # # @param events_ingested [Integer] - # # @param replace_existing_events [Boolean] - # # @param reverted_at [Time, nil] - # # @param status [Symbol, Orb::Models::Events::BackfillCreateResponse::Status] - # # @param timeframe_end [Time] - # # @param timeframe_start [Time] - # # @param deprecation_filter [String, nil] - # # - # def initialize( - # id:, - # close_time:, - # created_at:, - # customer_id:, - # events_ingested:, - # replace_existing_events:, - # reverted_at:, - # status:, - # timeframe_end:, - # timeframe_start:, - # deprecation_filter: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Events::BackfillCreateResponse} for more details. + # + # A backfill represents an update to historical usage data, adding or replacing + # events in a timeframe. + # + # @param id [String] + # + # @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in + # ... + # + # @param created_at [Time] + # + # @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null` + # ... + # + # @param events_ingested [Integer] The number of events ingested in this backfill. + # + # @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the + # ... + # + # @param reverted_at [Time, nil] The time at which this backfill was reverted. + # + # @param status [Symbol, Orb::Models::Events::BackfillCreateResponse::Status] The status of the backfill. + # + # @param timeframe_end [Time] + # + # @param timeframe_start [Time] + # + # @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie + # ... # The status of the backfill. # @@ -119,11 +117,8 @@ module Status PENDING_REVERT = :pending_revert REVERTED = :reverted - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/events/backfill_fetch_params.rb b/lib/orb/models/events/backfill_fetch_params.rb index 80d39c59..bf503d37 100644 --- a/lib/orb/models/events/backfill_fetch_params.rb +++ b/lib/orb/models/events/backfill_fetch_params.rb @@ -5,16 +5,11 @@ module Models module Events # @see Orb::Resources::Events::Backfills#fetch class BackfillFetchParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/events/backfill_fetch_response.rb b/lib/orb/models/events/backfill_fetch_response.rb index ebb3456a..2ae33188 100644 --- a/lib/orb/models/events/backfill_fetch_response.rb +++ b/lib/orb/models/events/backfill_fetch_response.rb @@ -73,40 +73,38 @@ class BackfillFetchResponse < Orb::Internal::Type::BaseModel # @return [String, nil] optional :deprecation_filter, String, nil?: true - # @!parse - # # A backfill represents an update to historical usage data, adding or replacing - # # events in a timeframe. - # # - # # @param id [String] - # # @param close_time [Time, nil] - # # @param created_at [Time] - # # @param customer_id [String, nil] - # # @param events_ingested [Integer] - # # @param replace_existing_events [Boolean] - # # @param reverted_at [Time, nil] - # # @param status [Symbol, Orb::Models::Events::BackfillFetchResponse::Status] - # # @param timeframe_end [Time] - # # @param timeframe_start [Time] - # # @param deprecation_filter [String, nil] - # # - # def initialize( - # id:, - # close_time:, - # created_at:, - # customer_id:, - # events_ingested:, - # replace_existing_events:, - # reverted_at:, - # status:, - # timeframe_end:, - # timeframe_start:, - # deprecation_filter: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Events::BackfillFetchResponse} for more details. + # + # A backfill represents an update to historical usage data, adding or replacing + # events in a timeframe. + # + # @param id [String] + # + # @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in + # ... + # + # @param created_at [Time] + # + # @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null` + # ... + # + # @param events_ingested [Integer] The number of events ingested in this backfill. + # + # @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the + # ... + # + # @param reverted_at [Time, nil] The time at which this backfill was reverted. + # + # @param status [Symbol, Orb::Models::Events::BackfillFetchResponse::Status] The status of the backfill. + # + # @param timeframe_end [Time] + # + # @param timeframe_start [Time] + # + # @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie + # ... # The status of the backfill. # @@ -119,11 +117,8 @@ module Status PENDING_REVERT = :pending_revert REVERTED = :reverted - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/events/backfill_list_params.rb b/lib/orb/models/events/backfill_list_params.rb index ee58760e..b70877c2 100644 --- a/lib/orb/models/events/backfill_list_params.rb +++ b/lib/orb/models/events/backfill_list_params.rb @@ -5,8 +5,7 @@ module Models module Events # @see Orb::Resources::Events::Backfills#list class BackfillListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute cursor @@ -16,24 +15,22 @@ class BackfillListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, limit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Events::BackfillListParams} for more details. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/events/backfill_list_response.rb b/lib/orb/models/events/backfill_list_response.rb index c201b98f..833d05e7 100644 --- a/lib/orb/models/events/backfill_list_response.rb +++ b/lib/orb/models/events/backfill_list_response.rb @@ -73,40 +73,38 @@ class BackfillListResponse < Orb::Internal::Type::BaseModel # @return [String, nil] optional :deprecation_filter, String, nil?: true - # @!parse - # # A backfill represents an update to historical usage data, adding or replacing - # # events in a timeframe. - # # - # # @param id [String] - # # @param close_time [Time, nil] - # # @param created_at [Time] - # # @param customer_id [String, nil] - # # @param events_ingested [Integer] - # # @param replace_existing_events [Boolean] - # # @param reverted_at [Time, nil] - # # @param status [Symbol, Orb::Models::Events::BackfillListResponse::Status] - # # @param timeframe_end [Time] - # # @param timeframe_start [Time] - # # @param deprecation_filter [String, nil] - # # - # def initialize( - # id:, - # close_time:, - # created_at:, - # customer_id:, - # events_ingested:, - # replace_existing_events:, - # reverted_at:, - # status:, - # timeframe_end:, - # timeframe_start:, - # deprecation_filter: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Events::BackfillListResponse} for more details. + # + # A backfill represents an update to historical usage data, adding or replacing + # events in a timeframe. + # + # @param id [String] + # + # @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in + # ... + # + # @param created_at [Time] + # + # @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null` + # ... + # + # @param events_ingested [Integer] The number of events ingested in this backfill. + # + # @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the + # ... + # + # @param reverted_at [Time, nil] The time at which this backfill was reverted. + # + # @param status [Symbol, Orb::Models::Events::BackfillListResponse::Status] The status of the backfill. + # + # @param timeframe_end [Time] + # + # @param timeframe_start [Time] + # + # @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie + # ... # The status of the backfill. # @@ -119,11 +117,8 @@ module Status PENDING_REVERT = :pending_revert REVERTED = :reverted - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/events/backfill_revert_params.rb b/lib/orb/models/events/backfill_revert_params.rb index 5af93c2a..943fb121 100644 --- a/lib/orb/models/events/backfill_revert_params.rb +++ b/lib/orb/models/events/backfill_revert_params.rb @@ -5,16 +5,11 @@ module Models module Events # @see Orb::Resources::Events::Backfills#revert class BackfillRevertParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/events/backfill_revert_response.rb b/lib/orb/models/events/backfill_revert_response.rb index f25bbcf6..7a42db9f 100644 --- a/lib/orb/models/events/backfill_revert_response.rb +++ b/lib/orb/models/events/backfill_revert_response.rb @@ -73,40 +73,38 @@ class BackfillRevertResponse < Orb::Internal::Type::BaseModel # @return [String, nil] optional :deprecation_filter, String, nil?: true - # @!parse - # # A backfill represents an update to historical usage data, adding or replacing - # # events in a timeframe. - # # - # # @param id [String] - # # @param close_time [Time, nil] - # # @param created_at [Time] - # # @param customer_id [String, nil] - # # @param events_ingested [Integer] - # # @param replace_existing_events [Boolean] - # # @param reverted_at [Time, nil] - # # @param status [Symbol, Orb::Models::Events::BackfillRevertResponse::Status] - # # @param timeframe_end [Time] - # # @param timeframe_start [Time] - # # @param deprecation_filter [String, nil] - # # - # def initialize( - # id:, - # close_time:, - # created_at:, - # customer_id:, - # events_ingested:, - # replace_existing_events:, - # reverted_at:, - # status:, - # timeframe_end:, - # timeframe_start:, - # deprecation_filter: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Events::BackfillRevertResponse} for more details. + # + # A backfill represents an update to historical usage data, adding or replacing + # events in a timeframe. + # + # @param id [String] + # + # @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in + # ... + # + # @param created_at [Time] + # + # @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null` + # ... + # + # @param events_ingested [Integer] The number of events ingested in this backfill. + # + # @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the + # ... + # + # @param reverted_at [Time, nil] The time at which this backfill was reverted. + # + # @param status [Symbol, Orb::Models::Events::BackfillRevertResponse::Status] The status of the backfill. + # + # @param timeframe_end [Time] + # + # @param timeframe_start [Time] + # + # @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie + # ... # The status of the backfill. # @@ -119,11 +117,8 @@ module Status PENDING_REVERT = :pending_revert REVERTED = :reverted - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/events/event_volumes.rb b/lib/orb/models/events/event_volumes.rb index b18e7ddf..5eb16a39 100644 --- a/lib/orb/models/events/event_volumes.rb +++ b/lib/orb/models/events/event_volumes.rb @@ -10,12 +10,8 @@ class EventVolumes < Orb::Internal::Type::BaseModel # @return [Array] required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Events::EventVolumes::Data] } - # @!parse - # # @param data [Array] - # # - # def initialize(data:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(data:) + # @param data [Array] class Data < Orb::Internal::Type::BaseModel # @!attribute count @@ -34,17 +30,15 @@ class Data < Orb::Internal::Type::BaseModel # @return [Time] required :timeframe_start, Time - # @!parse - # # An EventVolume contains the event volume ingested in an hourly window. The - # # timestamp used for the aggregation is the `timestamp` datetime field on events. - # # - # # @param count [Integer] - # # @param timeframe_end [Time] - # # @param timeframe_start [Time] - # # - # def initialize(count:, timeframe_end:, timeframe_start:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(count:, timeframe_end:, timeframe_start:) + # An EventVolume contains the event volume ingested in an hourly window. The + # timestamp used for the aggregation is the `timestamp` datetime field on events. + # + # @param count [Integer] The number of events ingested with a timestamp between the timeframe + # + # @param timeframe_end [Time] + # + # @param timeframe_start [Time] end end end diff --git a/lib/orb/models/events/volume_list_params.rb b/lib/orb/models/events/volume_list_params.rb index 9f9dbe90..39dcd0c3 100644 --- a/lib/orb/models/events/volume_list_params.rb +++ b/lib/orb/models/events/volume_list_params.rb @@ -5,8 +5,7 @@ module Models module Events # @see Orb::Resources::Events::Volume#list class VolumeListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute timeframe_start @@ -25,17 +24,13 @@ class VolumeListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] timeframe_end + # @!attribute timeframe_end # The end of the timeframe, exclusive, in which to return event volume. If not # specified, the current time is used. All datetime values are converted to UTC # time.If the specified time isn't hour-aligned, the response includes the event @@ -44,20 +39,22 @@ class VolumeListParams < Orb::Internal::Type::BaseModel # @return [Time, nil] optional :timeframe_end, Time - # @!parse - # # @return [Time] - # attr_writer :timeframe_end - - # @!parse - # # @param timeframe_start [Time] - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param timeframe_end [Time] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Events::VolumeListParams} for more details. + # + # @param timeframe_start [Time] The start of the timeframe, inclusive, in which to return event volume. All date + # ... + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param timeframe_end [Time] The end of the timeframe, exclusive, in which to return event volume. If not spe + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/invoice.rb b/lib/orb/models/invoice.rb index fa5ca019..05b2412a 100644 --- a/lib/orb/models/invoice.rb +++ b/lib/orb/models/invoice.rb @@ -166,6 +166,8 @@ class Invoice < Orb::Internal::Type::BaseModel required :customer_tax_id, -> { Orb::Models::Invoice::CustomerTaxID }, nil?: true # @!attribute discount + # @deprecated + # # This field is deprecated in favor of `discounts`. If a `discounts` list is # provided, the first discount in the list will be returned. If the list is empty, # `None` will be returned. @@ -364,103 +366,115 @@ class Invoice < Orb::Internal::Type::BaseModel # @return [Boolean] required :will_auto_issue, Orb::Internal::Type::Boolean - # @!parse - # # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, - # # representing the request for payment for a single subscription. This includes a - # # set of line items, which correspond to prices in the subscription's plan and can - # # represent fixed recurring fees or usage-based fees. They are generated at the - # # end of a billing period, or as the result of an action, such as a cancellation. - # # - # # @param id [String] - # # @param amount_due [String] - # # @param auto_collection [Orb::Models::Invoice::AutoCollection] - # # @param billing_address [Orb::Models::Invoice::BillingAddress, nil] - # # @param created_at [Time] - # # @param credit_notes [Array] - # # @param currency [String] - # # @param customer [Orb::Models::Invoice::Customer] - # # @param customer_balance_transactions [Array] - # # @param customer_tax_id [Orb::Models::Invoice::CustomerTaxID, nil] - # # @param discount [Object] - # # @param discounts [Array] - # # @param due_date [Time, nil] - # # @param eligible_to_issue_at [Time, nil] - # # @param hosted_invoice_url [String, nil] - # # @param invoice_date [Time] - # # @param invoice_number [String] - # # @param invoice_pdf [String, nil] - # # @param invoice_source [Symbol, Orb::Models::Invoice::InvoiceSource] - # # @param issue_failed_at [Time, nil] - # # @param issued_at [Time, nil] - # # @param line_items [Array] - # # @param maximum [Orb::Models::Invoice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param memo [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Invoice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param paid_at [Time, nil] - # # @param payment_attempts [Array] - # # @param payment_failed_at [Time, nil] - # # @param payment_started_at [Time, nil] - # # @param scheduled_issue_at [Time, nil] - # # @param shipping_address [Orb::Models::Invoice::ShippingAddress, nil] - # # @param status [Symbol, Orb::Models::Invoice::Status] - # # @param subscription [Orb::Models::Invoice::Subscription, nil] - # # @param subtotal [String] - # # @param sync_failed_at [Time, nil] - # # @param total [String] - # # @param voided_at [Time, nil] - # # @param will_auto_issue [Boolean] - # # - # def initialize( - # id:, - # amount_due:, - # auto_collection:, - # billing_address:, - # created_at:, - # credit_notes:, - # currency:, - # customer:, - # customer_balance_transactions:, - # customer_tax_id:, - # discount:, - # discounts:, - # due_date:, - # eligible_to_issue_at:, - # hosted_invoice_url:, - # invoice_date:, - # invoice_number:, - # invoice_pdf:, - # invoice_source:, - # issue_failed_at:, - # issued_at:, - # line_items:, - # maximum:, - # maximum_amount:, - # memo:, - # metadata:, - # minimum:, - # minimum_amount:, - # paid_at:, - # payment_attempts:, - # payment_failed_at:, - # payment_started_at:, - # scheduled_issue_at:, - # shipping_address:, - # status:, - # subscription:, - # subtotal:, - # sync_failed_at:, - # total:, - # voided_at:, - # will_auto_issue:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:) + # Some parameter documentations has been truncated, see {Orb::Models::Invoice} for + # more details. + # + # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, + # representing the request for payment for a single subscription. This includes a + # set of line items, which correspond to prices in the subscription's plan and can + # represent fixed recurring fees or usage-based fees. They are generated at the + # end of a billing period, or as the result of an action, such as a cancellation. + # + # @param id [String] + # + # @param amount_due [String] This is the final amount required to be charged to the customer and reflects the + # ... + # + # @param auto_collection [Orb::Models::Invoice::AutoCollection] + # + # @param billing_address [Orb::Models::Invoice::BillingAddress, nil] + # + # @param created_at [Time] The creation time of the resource in Orb. + # + # @param credit_notes [Array] A list of credit notes associated with the invoice + # + # @param currency [String] An ISO 4217 currency string or `credits` + # + # @param customer [Orb::Models::Invoice::Customer] + # + # @param customer_balance_transactions [Array] + # + # @param customer_tax_id [Orb::Models::Invoice::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad + # ... + # + # @param discount [Object] This field is deprecated in favor of `discounts`. If a `discounts` list is provi + # ... + # + # @param discounts [Array] + # + # @param due_date [Time, nil] When the invoice payment is due. The due date is null if the invoice is not yet + # ... + # + # @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w + # ... + # + # @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 30 days after the + # ... + # + # @param invoice_date [Time] The scheduled date of the invoice + # + # @param invoice_number [String] Automatically generated invoice number to help track and reconcile invoices. Inv + # ... + # + # @param invoice_pdf [String, nil] The link to download the PDF representation of the `Invoice`. + # + # @param invoice_source [Symbol, Orb::Models::Invoice::InvoiceSource] + # + # @param issue_failed_at [Time, nil] If the invoice failed to issue, this will be the last time it failed to issue (e + # ... + # + # @param issued_at [Time, nil] If the invoice has been issued, this will be the time it transitioned to `issued + # ... + # + # @param line_items [Array] The breakdown of prices in this invoice. + # + # @param maximum [Orb::Models::Invoice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal. + # ... + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Invoice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param paid_at [Time, nil] If the invoice has a status of `paid`, this gives a timestamp when the invoice w + # ... + # + # @param payment_attempts [Array] A list of payment attempts associated with the invoice + # + # @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th + # ... + # + # @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos + # ... + # + # @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche + # ... + # + # @param shipping_address [Orb::Models::Invoice::ShippingAddress, nil] + # + # @param status [Symbol, Orb::Models::Invoice::Status] + # + # @param subscription [Orb::Models::Invoice::Subscription, nil] + # + # @param subtotal [String] The total before any discounts and minimums are applied. + # + # @param sync_failed_at [Time, nil] If the invoice failed to sync, this will be the last time an external invoicing + # ... + # + # @param total [String] The total after any minimums and discounts have been applied. + # + # @param voided_at [Time, nil] If the invoice has a status of `void`, this gives a timestamp when the invoice w + # ... + # + # @param will_auto_issue [Boolean] This is true if the invoice will be automatically issued in the future, and fals + # ... # @see Orb::Models::Invoice#auto_collection class AutoCollection < Orb::Internal::Type::BaseModel @@ -495,15 +509,19 @@ class AutoCollection < Orb::Internal::Type::BaseModel # @return [Time, nil] required :previously_attempted_at, Time, nil?: true - # @!parse - # # @param enabled [Boolean, nil] - # # @param next_attempt_at [Time, nil] - # # @param num_attempts [Integer, nil] - # # @param previously_attempted_at [Time, nil] - # # - # def initialize(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Invoice::AutoCollection} for more details. + # + # @param enabled [Boolean, nil] True only if auto-collection is enabled for this invoice. + # + # @param next_attempt_at [Time, nil] If the invoice is scheduled for auto-collection, this field will reflect when th + # ... + # + # @param num_attempts [Integer, nil] Number of auto-collection payment attempts. + # + # @param previously_attempted_at [Time, nil] If Orb has ever attempted payment auto-collection for this invoice, this field w + # ... end # @see Orb::Models::Invoice#billing_address @@ -538,17 +556,13 @@ class BillingAddress < Orb::Internal::Type::BaseModel # @return [String, nil] required :state, String, nil?: true - # @!parse - # # @param city [String, nil] - # # @param country [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:) + # @param city [String, nil] + # @param country [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end class CreditNote < Orb::Internal::Type::BaseModel @@ -590,18 +604,24 @@ class CreditNote < Orb::Internal::Type::BaseModel # @return [Time, nil] required :voided_at, Time, nil?: true - # @!parse - # # @param id [String] - # # @param credit_note_number [String] - # # @param memo [String, nil] - # # @param reason [String] - # # @param total [String] - # # @param type [String] - # # @param voided_at [Time, nil] - # # - # def initialize(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Invoice::CreditNote} for more details. + # + # @param id [String] + # + # @param credit_note_number [String] + # + # @param memo [String, nil] An optional memo supplied on the credit note. + # + # @param reason [String] + # + # @param total [String] + # + # @param type [String] + # + # @param voided_at [Time, nil] If the credit note has a status of `void`, this gives a timestamp when the credi + # ... end # @see Orb::Models::Invoice#customer @@ -616,13 +636,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel @@ -684,35 +700,31 @@ class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Type] required :type, enum: -> { Orb::Models::Invoice::CustomerBalanceTransaction::Type } - # @!parse - # # @param id [String] - # # @param action [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Action] - # # @param amount [String] - # # @param created_at [Time] - # # @param credit_note [Orb::Models::Invoice::CustomerBalanceTransaction::CreditNote, nil] - # # @param description [String, nil] - # # @param ending_balance [String] - # # @param invoice [Orb::Models::Invoice::CustomerBalanceTransaction::Invoice, nil] - # # @param starting_balance [String] - # # @param type [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Type] - # # - # def initialize( - # id:, - # action:, - # amount:, - # created_at:, - # credit_note:, - # description:, - # ending_balance:, - # invoice:, - # starting_balance:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Invoice::CustomerBalanceTransaction} for more details. + # + # @param id [String] A unique id for this transaction. + # + # @param action [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Action] + # + # @param amount [String] The value of the amount changed in the transaction. + # + # @param created_at [Time] The creation time of this transaction. + # + # @param credit_note [Orb::Models::Invoice::CustomerBalanceTransaction::CreditNote, nil] + # + # @param description [String, nil] An optional description provided for manual customer balance adjustments. + # + # @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome + # ... + # + # @param invoice [Orb::Models::Invoice::CustomerBalanceTransaction::Invoice, nil] + # + # @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu + # ... + # + # @param type [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Type] # @see Orb::Models::Invoice::CustomerBalanceTransaction#action module Action @@ -728,11 +740,8 @@ module Action OVERPAYMENT_REFUND = :overpayment_refund EXTERNAL_PAYMENT = :external_payment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Invoice::CustomerBalanceTransaction#credit_note @@ -743,12 +752,8 @@ class CreditNote < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] The id of the Credit note end # @see Orb::Models::Invoice::CustomerBalanceTransaction#invoice @@ -759,12 +764,8 @@ class Invoice < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] The Invoice id end # @see Orb::Models::Invoice::CustomerBalanceTransaction#type @@ -774,11 +775,8 @@ module Type INCREMENT = :increment DECREMENT = :decrement - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -799,120 +797,116 @@ class CustomerTaxID < Orb::Internal::Type::BaseModel # @return [String] required :value, String - # @!parse - # # Tax IDs are commonly required to be displayed on customer invoices, which are - # # added to the headers of invoices. - # # - # # ### Supported Tax ID Countries and Types - # # - # # | Country | Type | Description | - # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # # | Andorra | `ad_nrt` | Andorran NRT Number | - # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # # | Austria | `eu_vat` | European VAT Number | - # # | Bahrain | `bh_vat` | Bahraini VAT Number | - # # | Belgium | `eu_vat` | European VAT Number | - # # | Bolivia | `bo_tin` | Bolivian Tax ID | - # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # # | Brazil | `br_cpf` | Brazilian CPF Number | - # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # # | Bulgaria | `eu_vat` | European VAT Number | - # # | Canada | `ca_bn` | Canadian BN | - # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # # | Chile | `cl_tin` | Chilean TIN | - # # | China | `cn_tin` | Chinese Tax ID | - # # | Colombia | `co_nit` | Colombian NIT Number | - # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # # | Croatia | `eu_vat` | European VAT Number | - # # | Cyprus | `eu_vat` | European VAT Number | - # # | Czech Republic | `eu_vat` | European VAT Number | - # # | Denmark | `eu_vat` | European VAT Number | - # # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # # | Estonia | `eu_vat` | European VAT Number | - # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # # | Finland | `eu_vat` | European VAT Number | - # # | France | `eu_vat` | European VAT Number | - # # | Georgia | `ge_vat` | Georgian VAT | - # # | Germany | `eu_vat` | European VAT Number | - # # | Greece | `eu_vat` | European VAT Number | - # # | Hong Kong | `hk_br` | Hong Kong BR Number | - # # | Hungary | `eu_vat` | European VAT Number | - # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # # | Iceland | `is_vat` | Icelandic VAT | - # # | India | `in_gst` | Indian GST Number | - # # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # # | Ireland | `eu_vat` | European VAT Number | - # # | Israel | `il_vat` | Israel VAT | - # # | Italy | `eu_vat` | European VAT Number | - # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # # | Latvia | `eu_vat` | European VAT Number | - # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # # | Lithuania | `eu_vat` | European VAT Number | - # # | Luxembourg | `eu_vat` | European VAT Number | - # # | Malaysia | `my_frp` | Malaysian FRP Number | - # # | Malaysia | `my_itn` | Malaysian ITN | - # # | Malaysia | `my_sst` | Malaysian SST Number | - # # | Malta | `eu_vat ` | European VAT Number | - # # | Mexico | `mx_rfc` | Mexican RFC Number | - # # | Netherlands | `eu_vat` | European VAT Number | - # # | New Zealand | `nz_gst` | New Zealand GST Number | - # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # # | Norway | `no_vat` | Norwegian VAT Number | - # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # # | Oman | `om_vat` | Omani VAT Number | - # # | Peru | `pe_ruc` | Peruvian RUC Number | - # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # # | Poland | `eu_vat` | European VAT Number | - # # | Portugal | `eu_vat` | European VAT Number | - # # | Romania | `eu_vat` | European VAT Number | - # # | Romania | `ro_tin` | Romanian Tax ID Number | - # # | Russia | `ru_inn` | Russian INN | - # # | Russia | `ru_kpp` | Russian KPP | - # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # # | Serbia | `rs_pib` | Serbian PIB Number | - # # | Singapore | `sg_gst` | Singaporean GST | - # # | Singapore | `sg_uen` | Singaporean UEN | - # # | Slovakia | `eu_vat` | European VAT Number | - # # | Slovenia | `eu_vat` | European VAT Number | - # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # # | South Africa | `za_vat` | South African VAT Number | - # # | South Korea | `kr_brn` | Korean BRN | - # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # # | Spain | `eu_vat` | European VAT Number | - # # | Sweden | `eu_vat` | European VAT Number | - # # | Switzerland | `ch_vat` | Switzerland VAT Number | - # # | Taiwan | `tw_vat` | Taiwanese VAT | - # # | Thailand | `th_vat` | Thai VAT | - # # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # # | Ukraine | `ua_vat` | Ukrainian VAT | - # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # # | United States | `us_ein` | United States EIN | - # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | - # # - # # @param country [Symbol, Orb::Models::Invoice::CustomerTaxID::Country] - # # @param type [Symbol, Orb::Models::Invoice::CustomerTaxID::Type] - # # @param value [String] - # # - # def initialize(country:, type:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(country:, type:, value:) + # Tax IDs are commonly required to be displayed on customer invoices, which are + # added to the headers of invoices. + # + # ### Supported Tax ID Countries and Types + # + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # + # @param country [Symbol, Orb::Models::Invoice::CustomerTaxID::Country] + # @param type [Symbol, Orb::Models::Invoice::CustomerTaxID::Type] + # @param value [String] # @see Orb::Models::Invoice::CustomerTaxID#country module Country @@ -997,11 +991,8 @@ module Country VN = :VN ZA = :ZA - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Invoice::CustomerTaxID#type @@ -1080,11 +1071,8 @@ module Type VN_TIN = :vn_tin ZA_VAT = :za_vat - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1096,11 +1084,8 @@ module InvoiceSource PARTIAL = :partial ONE_OFF = :one_off - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class LineItem < Orb::Internal::Type::BaseModel @@ -1165,24 +1150,32 @@ class LineItem < Orb::Internal::Type::BaseModel required :grouping, String, nil?: true # @!attribute maximum + # @deprecated + # # This field is deprecated in favor of `adjustments`. # # @return [Orb::Models::Invoice::LineItem::Maximum, nil] required :maximum, -> { Orb::Models::Invoice::LineItem::Maximum }, nil?: true # @!attribute maximum_amount + # @deprecated + # # This field is deprecated in favor of `adjustments`. # # @return [String, nil] required :maximum_amount, String, nil?: true # @!attribute minimum + # @deprecated + # # This field is deprecated in favor of `adjustments`. # # @return [Orb::Models::Invoice::LineItem::Minimum, nil] required :minimum, -> { Orb::Models::Invoice::LineItem::Minimum }, nil?: true # @!attribute minimum_amount + # @deprecated + # # This field is deprecated in favor of `adjustments`. # # @return [String, nil] @@ -1254,59 +1247,61 @@ class LineItem < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # @param id [String] - # # @param adjusted_subtotal [String] - # # @param adjustments [Array] - # # @param amount [String] - # # @param credits_applied [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param end_date [Time] - # # @param filter [String, nil] - # # @param grouping [String, nil] - # # @param maximum [Orb::Models::Invoice::LineItem::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param minimum [Orb::Models::Invoice::LineItem::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param partially_invoiced_amount [String] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil] - # # @param quantity [Float] - # # @param start_date [Time] - # # @param sub_line_items [Array] - # # @param subtotal [String] - # # @param tax_amounts [Array] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # adjusted_subtotal:, - # adjustments:, - # amount:, - # credits_applied:, - # discount:, - # end_date:, - # filter:, - # grouping:, - # maximum:, - # maximum_amount:, - # minimum:, - # minimum_amount:, - # name:, - # partially_invoiced_amount:, - # price:, - # quantity:, - # start_date:, - # sub_line_items:, - # subtotal:, - # tax_amounts:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjusted_subtotal:, adjustments:, amount:, credits_applied:, discount:, end_date:, filter:, grouping:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, partially_invoiced_amount:, price:, quantity:, start_date:, sub_line_items:, subtotal:, tax_amounts:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Invoice::LineItem} for more details. + # + # @param id [String] A unique ID for this line item. + # + # @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and + # ... + # + # @param adjustments [Array] All adjustments applied to the line item in the order they were applied based on + # ... + # + # @param amount [String] The final amount for a line item after all adjustments and pre paid credits have + # ... + # + # @param credits_applied [String] The number of prepaid credits applied. + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param end_date [Time] The end date of the range of time applied for this line item's price. + # + # @param filter [String, nil] An additional filter that was used to calculate the usage for this line item. + # + # @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b + # ... + # + # @param maximum [Orb::Models::Invoice::LineItem::Maximum, nil] This field is deprecated in favor of `adjustments`. + # + # @param maximum_amount [String, nil] This field is deprecated in favor of `adjustments`. + # + # @param minimum [Orb::Models::Invoice::LineItem::Minimum, nil] This field is deprecated in favor of `adjustments`. + # + # @param minimum_amount [String, nil] This field is deprecated in favor of `adjustments`. + # + # @param name [String] The name of the price associated with this line item. + # + # @param partially_invoiced_amount [String] Any amount applied from a partial invoice + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param quantity [Float] Either the fixed fee quantity or the usage during the service period. + # + # @param start_date [Time] The start date of the range of time applied for this line item's price. + # + # @param sub_line_items [Array] For complex pricing structures, the line item can be broken down further in `sub + # ... + # + # @param subtotal [String] The line amount before before any adjustments. + # + # @param tax_amounts [Array] An array of tax rates and their incurred tax amounts. Empty if no tax integratio + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer ids that were used to calculate the usage for this line item. + # ... module Adjustment extend Orb::Internal::Type::Union @@ -1369,29 +1364,26 @@ class MonetaryUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # amount:, - # applies_to_price_ids:, - # is_invoice_level:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -1437,29 +1429,26 @@ class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, is_invoice_level:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -1505,29 +1494,26 @@ class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # amount:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -1579,31 +1565,28 @@ class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # amount:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment} for more + # details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -1649,34 +1632,30 @@ class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # amount:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment} for more + # details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment)] end # @deprecated @@ -1696,15 +1675,16 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # This field is deprecated in favor of `adjustments`. - # # - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Invoice::LineItem::Maximum} for more details. + # + # This field is deprecated in favor of `adjustments`. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @deprecated @@ -1724,15 +1704,16 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # This field is deprecated in favor of `adjustments`. - # # - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Invoice::LineItem::Minimum} for more details. + # + # This field is deprecated in favor of `adjustments`. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end module SubLineItem @@ -1781,17 +1762,18 @@ class MatrixSubLineItem < Orb::Internal::Type::BaseModel # @return [Symbol, :matrix] required :type, const: :matrix - # @!parse - # # @param amount [String] - # # @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem::Grouping, nil] - # # @param matrix_config [Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig] - # # @param name [String] - # # @param quantity [Float] - # # @param type [Symbol, :matrix] - # # - # def initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix) + # @param amount [String] The total amount for this sub line item. + # + # @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem::Grouping, nil] + # + # @param matrix_config [Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig] + # + # @param name [String] + # + # @param quantity [Float] + # + # @param type [Symbol, :matrix] # @see Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem#grouping class Grouping < Orb::Internal::Type::BaseModel @@ -1806,13 +1788,10 @@ class Grouping < Orb::Internal::Type::BaseModel # @return [String, nil] required :value, String, nil?: true - # @!parse - # # @param key [String] - # # @param value [String, nil] - # # - # def initialize(key:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(key:, value:) + # @param key [String] + # + # @param value [String, nil] No value indicates the default group end # @see Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem#matrix_config @@ -1823,12 +1802,8 @@ class MatrixConfig < Orb::Internal::Type::BaseModel # @return [Array] required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true] - # @!parse - # # @param dimension_values [Array] - # # - # def initialize(dimension_values:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:) + # @param dimension_values [Array] The ordered dimension values for this line item. end end @@ -1866,17 +1841,18 @@ class TierSubLineItem < Orb::Internal::Type::BaseModel # @return [Symbol, :tier] required :type, const: :tier - # @!parse - # # @param amount [String] - # # @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem::Grouping, nil] - # # @param name [String] - # # @param quantity [Float] - # # @param tier_config [Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem::TierConfig] - # # @param type [Symbol, :tier] - # # - # def initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier) + # @param amount [String] The total amount for this sub line item. + # + # @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem::Grouping, nil] + # + # @param name [String] + # + # @param quantity [Float] + # + # @param tier_config [Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem::TierConfig] + # + # @param type [Symbol, :tier] # @see Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem#grouping class Grouping < Orb::Internal::Type::BaseModel @@ -1891,13 +1867,10 @@ class Grouping < Orb::Internal::Type::BaseModel # @return [String, nil] required :value, String, nil?: true - # @!parse - # # @param key [String] - # # @param value [String, nil] - # # - # def initialize(key:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(key:, value:) + # @param key [String] + # + # @param value [String, nil] No value indicates the default group end # @see Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem#tier_config @@ -1917,14 +1890,10 @@ class TierConfig < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param first_unit [Float] - # # @param last_unit [Float, nil] - # # @param unit_amount [String] - # # - # def initialize(first_unit:, last_unit:, unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(first_unit:, last_unit:, unit_amount:) + # @param first_unit [Float] + # @param last_unit [Float, nil] + # @param unit_amount [String] end end @@ -1957,16 +1926,16 @@ class OtherSubLineItem < Orb::Internal::Type::BaseModel # @return [Symbol, :"'null'"] required :type, const: :"'null'" - # @!parse - # # @param amount [String] - # # @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem::Grouping, nil] - # # @param name [String] - # # @param quantity [Float] - # # @param type [Symbol, :"'null'"] - # # - # def initialize(amount:, grouping:, name:, quantity:, type: :"'null'", **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'") + # @param amount [String] The total amount for this sub line item. + # + # @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem::Grouping, nil] + # + # @param name [String] + # + # @param quantity [Float] + # + # @param type [Symbol, :"'null'"] # @see Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem#grouping class Grouping < Orb::Internal::Type::BaseModel @@ -1981,19 +1950,15 @@ class Grouping < Orb::Internal::Type::BaseModel # @return [String, nil] required :value, String, nil?: true - # @!parse - # # @param key [String] - # # @param value [String, nil] - # # - # def initialize(key:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(key:, value:) + # @param key [String] + # + # @param value [String, nil] No value indicates the default group end end - # @!parse - # # @return [Array(Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem, Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem, Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem)] end class TaxAmount < Orb::Internal::Type::BaseModel @@ -2015,14 +1980,12 @@ class TaxAmount < Orb::Internal::Type::BaseModel # @return [String, nil] required :tax_rate_percentage, String, nil?: true - # @!parse - # # @param amount [String] - # # @param tax_rate_description [String] - # # @param tax_rate_percentage [String, nil] - # # - # def initialize(amount:, tax_rate_description:, tax_rate_percentage:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:) + # @param amount [String] The amount of additional tax incurred by this tax rate. + # + # @param tax_rate_description [String] The human-readable description of the applied tax rate. + # + # @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100. end end @@ -2041,13 +2004,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Invoice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Invoice#minimum @@ -2065,13 +2029,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Invoice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end class PaymentAttempt < Orb::Internal::Type::BaseModel @@ -2111,17 +2076,18 @@ class PaymentAttempt < Orb::Internal::Type::BaseModel # @return [Boolean] required :succeeded, Orb::Internal::Type::Boolean - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param created_at [Time] - # # @param payment_provider [Symbol, Orb::Models::Invoice::PaymentAttempt::PaymentProvider, nil] - # # @param payment_provider_id [String, nil] - # # @param succeeded [Boolean] - # # - # def initialize(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:) + # @param id [String] The ID of the payment attempt. + # + # @param amount [String] The amount of the payment attempt. + # + # @param created_at [Time] The time at which the payment attempt was created. + # + # @param payment_provider [Symbol, Orb::Models::Invoice::PaymentAttempt::PaymentProvider, nil] The payment provider that attempted to collect the payment. + # + # @param payment_provider_id [String, nil] The ID of the payment attempt in the payment provider. + # + # @param succeeded [Boolean] Whether the payment attempt succeeded. # The payment provider that attempted to collect the payment. # @@ -2131,11 +2097,8 @@ module PaymentProvider STRIPE = :stripe - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2171,17 +2134,13 @@ class ShippingAddress < Orb::Internal::Type::BaseModel # @return [String, nil] required :state, String, nil?: true - # @!parse - # # @param city [String, nil] - # # @param country [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:) + # @param city [String, nil] + # @param country [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end # @see Orb::Models::Invoice#status @@ -2194,11 +2153,8 @@ module Status VOID = :void DRAFT = :draft - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Invoice#subscription @@ -2208,12 +2164,8 @@ class Subscription < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end end end diff --git a/lib/orb/models/invoice_create_params.rb b/lib/orb/models/invoice_create_params.rb index 8f92bf66..698f27d5 100644 --- a/lib/orb/models/invoice_create_params.rb +++ b/lib/orb/models/invoice_create_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Invoices#create class InvoiceCreateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute currency @@ -70,7 +69,7 @@ class InvoiceCreateParams < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!attribute [r] will_auto_issue + # @!attribute will_auto_issue # When true, this invoice will be submitted for issuance upon creation. When # false, the resulting invoice will require manual review to issue. Defaulted to # false. @@ -78,41 +77,38 @@ class InvoiceCreateParams < Orb::Internal::Type::BaseModel # @return [Boolean, nil] optional :will_auto_issue, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :will_auto_issue - - # @!parse - # # @param currency [String] - # # @param invoice_date [Time] - # # @param line_items [Array] - # # @param net_terms [Integer] - # # @param customer_id [String, nil] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_customer_id [String, nil] - # # @param memo [String, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param will_auto_issue [Boolean] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # currency:, - # invoice_date:, - # line_items:, - # net_terms:, - # customer_id: nil, - # discount: nil, - # external_customer_id: nil, - # memo: nil, - # metadata: nil, - # will_auto_issue: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(currency:, invoice_date:, line_items:, net_terms:, customer_id: nil, discount: nil, external_customer_id: nil, memo: nil, metadata: nil, will_auto_issue: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceCreateParams} for more details. + # + # @param currency [String] An ISO 4217 currency string. Must be the same as the customer's currency if it i + # ... + # + # @param invoice_date [Time] Optional invoice date to set. Must be in the past, if not set, `invoice_date` is + # ... + # + # @param line_items [Array] + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param customer_id [String, nil] The id of the `Customer` to create this invoice for. One of `customer_id` and `e + # ... + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] An optional discount to attach to the invoice. + # + # @param external_customer_id [String, nil] The `external_customer_id` of the `Customer` to create this invoice for. One of + # ... + # + # @param memo [String, nil] An optional memo to attach to the invoice. + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param will_auto_issue [Boolean] When true, this invoice will be submitted for issuance upon creation. When false + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] class LineItem < Orb::Internal::Type::BaseModel # @!attribute end_date @@ -154,18 +150,20 @@ class LineItem < Orb::Internal::Type::BaseModel # @return [Orb::Models::InvoiceCreateParams::LineItem::UnitConfig] required :unit_config, -> { Orb::Models::InvoiceCreateParams::LineItem::UnitConfig } - # @!parse - # # @param end_date [Date] - # # @param item_id [String] - # # @param model_type [Symbol, Orb::Models::InvoiceCreateParams::LineItem::ModelType] - # # @param name [String] - # # @param quantity [Float] - # # @param start_date [Date] - # # @param unit_config [Orb::Models::InvoiceCreateParams::LineItem::UnitConfig] - # # - # def initialize(end_date:, item_id:, model_type:, name:, quantity:, start_date:, unit_config:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, item_id:, model_type:, name:, quantity:, start_date:, unit_config:) + # @param end_date [Date] A date string to specify the line item's end date in the customer's timezone. + # + # @param item_id [String] + # + # @param model_type [Symbol, Orb::Models::InvoiceCreateParams::LineItem::ModelType] + # + # @param name [String] The name of the line item. + # + # @param quantity [Float] The number of units on the line item + # + # @param start_date [Date] A date string to specify the line item's start date in the customer's timezone. + # + # @param unit_config [Orb::Models::InvoiceCreateParams::LineItem::UnitConfig] # @see Orb::Models::InvoiceCreateParams::LineItem#model_type module ModelType @@ -173,11 +171,8 @@ module ModelType UNIT = :unit - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::InvoiceCreateParams::LineItem#unit_config @@ -188,12 +183,8 @@ class UnitConfig < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param unit_amount [String] - # # - # def initialize(unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:) + # @param unit_amount [String] Rate per unit of usage end end end diff --git a/lib/orb/models/invoice_fetch_params.rb b/lib/orb/models/invoice_fetch_params.rb index c27f0847..a97bb2fb 100644 --- a/lib/orb/models/invoice_fetch_params.rb +++ b/lib/orb/models/invoice_fetch_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Invoices#fetch class InvoiceFetchParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/invoice_fetch_upcoming_params.rb b/lib/orb/models/invoice_fetch_upcoming_params.rb index 3d88e0bf..8ceee845 100644 --- a/lib/orb/models/invoice_fetch_upcoming_params.rb +++ b/lib/orb/models/invoice_fetch_upcoming_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Invoices#fetch_upcoming class InvoiceFetchUpcomingParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute subscription_id @@ -13,13 +12,9 @@ class InvoiceFetchUpcomingParams < Orb::Internal::Type::BaseModel # @return [String] required :subscription_id, String - # @!parse - # # @param subscription_id [String] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(subscription_id:, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(subscription_id:, request_options: {}) + # @param subscription_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/invoice_fetch_upcoming_response.rb b/lib/orb/models/invoice_fetch_upcoming_response.rb index 26181e50..8d27d374 100644 --- a/lib/orb/models/invoice_fetch_upcoming_response.rb +++ b/lib/orb/models/invoice_fetch_upcoming_response.rb @@ -167,6 +167,8 @@ class InvoiceFetchUpcomingResponse < Orb::Internal::Type::BaseModel required :customer_tax_id, -> { Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID }, nil?: true # @!attribute discount + # @deprecated + # # This field is deprecated in favor of `discounts`. If a `discounts` list is # provided, the first discount in the list will be returned. If the list is empty, # `None` will be returned. @@ -367,97 +369,109 @@ class InvoiceFetchUpcomingResponse < Orb::Internal::Type::BaseModel # @return [Boolean] required :will_auto_issue, Orb::Internal::Type::Boolean - # @!parse - # # @param id [String] - # # @param amount_due [String] - # # @param auto_collection [Orb::Models::InvoiceFetchUpcomingResponse::AutoCollection] - # # @param billing_address [Orb::Models::InvoiceFetchUpcomingResponse::BillingAddress, nil] - # # @param created_at [Time] - # # @param credit_notes [Array] - # # @param currency [String] - # # @param customer [Orb::Models::InvoiceFetchUpcomingResponse::Customer] - # # @param customer_balance_transactions [Array] - # # @param customer_tax_id [Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID, nil] - # # @param discount [Object] - # # @param discounts [Array] - # # @param due_date [Time, nil] - # # @param eligible_to_issue_at [Time, nil] - # # @param hosted_invoice_url [String, nil] - # # @param invoice_number [String] - # # @param invoice_pdf [String, nil] - # # @param invoice_source [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource] - # # @param issue_failed_at [Time, nil] - # # @param issued_at [Time, nil] - # # @param line_items [Array] - # # @param maximum [Orb::Models::InvoiceFetchUpcomingResponse::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param memo [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::InvoiceFetchUpcomingResponse::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param paid_at [Time, nil] - # # @param payment_attempts [Array] - # # @param payment_failed_at [Time, nil] - # # @param payment_started_at [Time, nil] - # # @param scheduled_issue_at [Time, nil] - # # @param shipping_address [Orb::Models::InvoiceFetchUpcomingResponse::ShippingAddress, nil] - # # @param status [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Status] - # # @param subscription [Orb::Models::InvoiceFetchUpcomingResponse::Subscription, nil] - # # @param subtotal [String] - # # @param sync_failed_at [Time, nil] - # # @param target_date [Time] - # # @param total [String] - # # @param voided_at [Time, nil] - # # @param will_auto_issue [Boolean] - # # - # def initialize( - # id:, - # amount_due:, - # auto_collection:, - # billing_address:, - # created_at:, - # credit_notes:, - # currency:, - # customer:, - # customer_balance_transactions:, - # customer_tax_id:, - # discount:, - # discounts:, - # due_date:, - # eligible_to_issue_at:, - # hosted_invoice_url:, - # invoice_number:, - # invoice_pdf:, - # invoice_source:, - # issue_failed_at:, - # issued_at:, - # line_items:, - # maximum:, - # maximum_amount:, - # memo:, - # metadata:, - # minimum:, - # minimum_amount:, - # paid_at:, - # payment_attempts:, - # payment_failed_at:, - # payment_started_at:, - # scheduled_issue_at:, - # shipping_address:, - # status:, - # subscription:, - # subtotal:, - # sync_failed_at:, - # target_date:, - # total:, - # voided_at:, - # will_auto_issue:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, target_date:, total:, voided_at:, will_auto_issue:) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceFetchUpcomingResponse} for more details. + # + # @param id [String] + # + # @param amount_due [String] This is the final amount required to be charged to the customer and reflects the + # ... + # + # @param auto_collection [Orb::Models::InvoiceFetchUpcomingResponse::AutoCollection] + # + # @param billing_address [Orb::Models::InvoiceFetchUpcomingResponse::BillingAddress, nil] + # + # @param created_at [Time] The creation time of the resource in Orb. + # + # @param credit_notes [Array] A list of credit notes associated with the invoice + # + # @param currency [String] An ISO 4217 currency string or `credits` + # + # @param customer [Orb::Models::InvoiceFetchUpcomingResponse::Customer] + # + # @param customer_balance_transactions [Array] + # + # @param customer_tax_id [Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad + # ... + # + # @param discount [Object] This field is deprecated in favor of `discounts`. If a `discounts` list is provi + # ... + # + # @param discounts [Array] + # + # @param due_date [Time, nil] When the invoice payment is due. The due date is null if the invoice is not yet + # ... + # + # @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w + # ... + # + # @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 30 days after the + # ... + # + # @param invoice_number [String] Automatically generated invoice number to help track and reconcile invoices. Inv + # ... + # + # @param invoice_pdf [String, nil] The link to download the PDF representation of the `Invoice`. + # + # @param invoice_source [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource] + # + # @param issue_failed_at [Time, nil] If the invoice failed to issue, this will be the last time it failed to issue (e + # ... + # + # @param issued_at [Time, nil] If the invoice has been issued, this will be the time it transitioned to `issued + # ... + # + # @param line_items [Array] The breakdown of prices in this invoice. + # + # @param maximum [Orb::Models::InvoiceFetchUpcomingResponse::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal. + # ... + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::InvoiceFetchUpcomingResponse::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param paid_at [Time, nil] If the invoice has a status of `paid`, this gives a timestamp when the invoice w + # ... + # + # @param payment_attempts [Array] A list of payment attempts associated with the invoice + # + # @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th + # ... + # + # @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos + # ... + # + # @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche + # ... + # + # @param shipping_address [Orb::Models::InvoiceFetchUpcomingResponse::ShippingAddress, nil] + # + # @param status [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Status] + # + # @param subscription [Orb::Models::InvoiceFetchUpcomingResponse::Subscription, nil] + # + # @param subtotal [String] The total before any discounts and minimums are applied. + # + # @param sync_failed_at [Time, nil] If the invoice failed to sync, this will be the last time an external invoicing + # ... + # + # @param target_date [Time] The scheduled date of the invoice + # + # @param total [String] The total after any minimums and discounts have been applied. + # + # @param voided_at [Time, nil] If the invoice has a status of `void`, this gives a timestamp when the invoice w + # ... + # + # @param will_auto_issue [Boolean] This is true if the invoice will be automatically issued in the future, and fals + # ... # @see Orb::Models::InvoiceFetchUpcomingResponse#auto_collection class AutoCollection < Orb::Internal::Type::BaseModel @@ -492,15 +506,19 @@ class AutoCollection < Orb::Internal::Type::BaseModel # @return [Time, nil] required :previously_attempted_at, Time, nil?: true - # @!parse - # # @param enabled [Boolean, nil] - # # @param next_attempt_at [Time, nil] - # # @param num_attempts [Integer, nil] - # # @param previously_attempted_at [Time, nil] - # # - # def initialize(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceFetchUpcomingResponse::AutoCollection} for more details. + # + # @param enabled [Boolean, nil] True only if auto-collection is enabled for this invoice. + # + # @param next_attempt_at [Time, nil] If the invoice is scheduled for auto-collection, this field will reflect when th + # ... + # + # @param num_attempts [Integer, nil] Number of auto-collection payment attempts. + # + # @param previously_attempted_at [Time, nil] If Orb has ever attempted payment auto-collection for this invoice, this field w + # ... end # @see Orb::Models::InvoiceFetchUpcomingResponse#billing_address @@ -535,17 +553,13 @@ class BillingAddress < Orb::Internal::Type::BaseModel # @return [String, nil] required :state, String, nil?: true - # @!parse - # # @param city [String, nil] - # # @param country [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:) + # @param city [String, nil] + # @param country [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end class CreditNote < Orb::Internal::Type::BaseModel @@ -587,18 +601,24 @@ class CreditNote < Orb::Internal::Type::BaseModel # @return [Time, nil] required :voided_at, Time, nil?: true - # @!parse - # # @param id [String] - # # @param credit_note_number [String] - # # @param memo [String, nil] - # # @param reason [String] - # # @param total [String] - # # @param type [String] - # # @param voided_at [Time, nil] - # # - # def initialize(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceFetchUpcomingResponse::CreditNote} for more details. + # + # @param id [String] + # + # @param credit_note_number [String] + # + # @param memo [String, nil] An optional memo supplied on the credit note. + # + # @param reason [String] + # + # @param total [String] + # + # @param type [String] + # + # @param voided_at [Time, nil] If the credit note has a status of `void`, this gives a timestamp when the credi + # ... end # @see Orb::Models::InvoiceFetchUpcomingResponse#customer @@ -613,13 +633,9 @@ class Customer < Orb::Internal::Type::BaseModel # @return [String, nil] required :external_customer_id, String, nil?: true - # @!parse - # # @param id [String] - # # @param external_customer_id [String, nil] - # # - # def initialize(id:, external_customer_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_customer_id:) + # @param id [String] + # @param external_customer_id [String, nil] end class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel @@ -686,35 +702,32 @@ class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type] required :type, enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type } - # @!parse - # # @param id [String] - # # @param action [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action] - # # @param amount [String] - # # @param created_at [Time] - # # @param credit_note [Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::CreditNote, nil] - # # @param description [String, nil] - # # @param ending_balance [String] - # # @param invoice [Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Invoice, nil] - # # @param starting_balance [String] - # # @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type] - # # - # def initialize( - # id:, - # action:, - # amount:, - # created_at:, - # credit_note:, - # description:, - # ending_balance:, - # invoice:, - # starting_balance:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction} for more + # details. + # + # @param id [String] A unique id for this transaction. + # + # @param action [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action] + # + # @param amount [String] The value of the amount changed in the transaction. + # + # @param created_at [Time] The creation time of this transaction. + # + # @param credit_note [Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::CreditNote, nil] + # + # @param description [String, nil] An optional description provided for manual customer balance adjustments. + # + # @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome + # ... + # + # @param invoice [Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Invoice, nil] + # + # @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu + # ... + # + # @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type] # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#action module Action @@ -730,11 +743,8 @@ module Action OVERPAYMENT_REFUND = :overpayment_refund EXTERNAL_PAYMENT = :external_payment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#credit_note @@ -745,12 +755,8 @@ class CreditNote < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] The id of the Credit note end # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#invoice @@ -761,12 +767,8 @@ class Invoice < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] The Invoice id end # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#type @@ -776,11 +778,8 @@ module Type INCREMENT = :increment DECREMENT = :decrement - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -801,120 +800,116 @@ class CustomerTaxID < Orb::Internal::Type::BaseModel # @return [String] required :value, String - # @!parse - # # Tax IDs are commonly required to be displayed on customer invoices, which are - # # added to the headers of invoices. - # # - # # ### Supported Tax ID Countries and Types - # # - # # | Country | Type | Description | - # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # # | Andorra | `ad_nrt` | Andorran NRT Number | - # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # # | Austria | `eu_vat` | European VAT Number | - # # | Bahrain | `bh_vat` | Bahraini VAT Number | - # # | Belgium | `eu_vat` | European VAT Number | - # # | Bolivia | `bo_tin` | Bolivian Tax ID | - # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # # | Brazil | `br_cpf` | Brazilian CPF Number | - # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # # | Bulgaria | `eu_vat` | European VAT Number | - # # | Canada | `ca_bn` | Canadian BN | - # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # # | Chile | `cl_tin` | Chilean TIN | - # # | China | `cn_tin` | Chinese Tax ID | - # # | Colombia | `co_nit` | Colombian NIT Number | - # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # # | Croatia | `eu_vat` | European VAT Number | - # # | Cyprus | `eu_vat` | European VAT Number | - # # | Czech Republic | `eu_vat` | European VAT Number | - # # | Denmark | `eu_vat` | European VAT Number | - # # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # # | Estonia | `eu_vat` | European VAT Number | - # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # # | Finland | `eu_vat` | European VAT Number | - # # | France | `eu_vat` | European VAT Number | - # # | Georgia | `ge_vat` | Georgian VAT | - # # | Germany | `eu_vat` | European VAT Number | - # # | Greece | `eu_vat` | European VAT Number | - # # | Hong Kong | `hk_br` | Hong Kong BR Number | - # # | Hungary | `eu_vat` | European VAT Number | - # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # # | Iceland | `is_vat` | Icelandic VAT | - # # | India | `in_gst` | Indian GST Number | - # # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # # | Ireland | `eu_vat` | European VAT Number | - # # | Israel | `il_vat` | Israel VAT | - # # | Italy | `eu_vat` | European VAT Number | - # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # # | Latvia | `eu_vat` | European VAT Number | - # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # # | Lithuania | `eu_vat` | European VAT Number | - # # | Luxembourg | `eu_vat` | European VAT Number | - # # | Malaysia | `my_frp` | Malaysian FRP Number | - # # | Malaysia | `my_itn` | Malaysian ITN | - # # | Malaysia | `my_sst` | Malaysian SST Number | - # # | Malta | `eu_vat ` | European VAT Number | - # # | Mexico | `mx_rfc` | Mexican RFC Number | - # # | Netherlands | `eu_vat` | European VAT Number | - # # | New Zealand | `nz_gst` | New Zealand GST Number | - # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # # | Norway | `no_vat` | Norwegian VAT Number | - # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # # | Oman | `om_vat` | Omani VAT Number | - # # | Peru | `pe_ruc` | Peruvian RUC Number | - # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # # | Poland | `eu_vat` | European VAT Number | - # # | Portugal | `eu_vat` | European VAT Number | - # # | Romania | `eu_vat` | European VAT Number | - # # | Romania | `ro_tin` | Romanian Tax ID Number | - # # | Russia | `ru_inn` | Russian INN | - # # | Russia | `ru_kpp` | Russian KPP | - # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # # | Serbia | `rs_pib` | Serbian PIB Number | - # # | Singapore | `sg_gst` | Singaporean GST | - # # | Singapore | `sg_uen` | Singaporean UEN | - # # | Slovakia | `eu_vat` | European VAT Number | - # # | Slovenia | `eu_vat` | European VAT Number | - # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # # | South Africa | `za_vat` | South African VAT Number | - # # | South Korea | `kr_brn` | Korean BRN | - # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # # | Spain | `eu_vat` | European VAT Number | - # # | Sweden | `eu_vat` | European VAT Number | - # # | Switzerland | `ch_vat` | Switzerland VAT Number | - # # | Taiwan | `tw_vat` | Taiwanese VAT | - # # | Thailand | `th_vat` | Thai VAT | - # # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # # | Ukraine | `ua_vat` | Ukrainian VAT | - # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # # | United States | `us_ein` | United States EIN | - # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | - # # - # # @param country [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country] - # # @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type] - # # @param value [String] - # # - # def initialize(country:, type:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(country:, type:, value:) + # Tax IDs are commonly required to be displayed on customer invoices, which are + # added to the headers of invoices. + # + # ### Supported Tax ID Countries and Types + # + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # + # @param country [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country] + # @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type] + # @param value [String] # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID#country module Country @@ -999,11 +994,8 @@ module Country VN = :VN ZA = :ZA - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID#type @@ -1082,11 +1074,8 @@ module Type VN_TIN = :vn_tin ZA_VAT = :za_vat - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1098,11 +1087,8 @@ module InvoiceSource PARTIAL = :partial ONE_OFF = :one_off - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class LineItem < Orb::Internal::Type::BaseModel @@ -1167,24 +1153,32 @@ class LineItem < Orb::Internal::Type::BaseModel required :grouping, String, nil?: true # @!attribute maximum + # @deprecated + # # This field is deprecated in favor of `adjustments`. # # @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum, nil] required :maximum, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum }, nil?: true # @!attribute maximum_amount + # @deprecated + # # This field is deprecated in favor of `adjustments`. # # @return [String, nil] required :maximum_amount, String, nil?: true # @!attribute minimum + # @deprecated + # # This field is deprecated in favor of `adjustments`. # # @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum, nil] required :minimum, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum }, nil?: true # @!attribute minimum_amount + # @deprecated + # # This field is deprecated in favor of `adjustments`. # # @return [String, nil] @@ -1257,59 +1251,61 @@ class LineItem < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # @param id [String] - # # @param adjusted_subtotal [String] - # # @param adjustments [Array] - # # @param amount [String] - # # @param credits_applied [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param end_date [Time] - # # @param filter [String, nil] - # # @param grouping [String, nil] - # # @param maximum [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param minimum [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param partially_invoiced_amount [String] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil] - # # @param quantity [Float] - # # @param start_date [Time] - # # @param sub_line_items [Array] - # # @param subtotal [String] - # # @param tax_amounts [Array] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # adjusted_subtotal:, - # adjustments:, - # amount:, - # credits_applied:, - # discount:, - # end_date:, - # filter:, - # grouping:, - # maximum:, - # maximum_amount:, - # minimum:, - # minimum_amount:, - # name:, - # partially_invoiced_amount:, - # price:, - # quantity:, - # start_date:, - # sub_line_items:, - # subtotal:, - # tax_amounts:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjusted_subtotal:, adjustments:, amount:, credits_applied:, discount:, end_date:, filter:, grouping:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, partially_invoiced_amount:, price:, quantity:, start_date:, sub_line_items:, subtotal:, tax_amounts:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem} for more details. + # + # @param id [String] A unique ID for this line item. + # + # @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and + # ... + # + # @param adjustments [Array] All adjustments applied to the line item in the order they were applied based on + # ... + # + # @param amount [String] The final amount for a line item after all adjustments and pre paid credits have + # ... + # + # @param credits_applied [String] The number of prepaid credits applied. + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param end_date [Time] The end date of the range of time applied for this line item's price. + # + # @param filter [String, nil] An additional filter that was used to calculate the usage for this line item. + # + # @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b + # ... + # + # @param maximum [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum, nil] This field is deprecated in favor of `adjustments`. + # + # @param maximum_amount [String, nil] This field is deprecated in favor of `adjustments`. + # + # @param minimum [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum, nil] This field is deprecated in favor of `adjustments`. + # + # @param minimum_amount [String, nil] This field is deprecated in favor of `adjustments`. + # + # @param name [String] The name of the price associated with this line item. + # + # @param partially_invoiced_amount [String] Any amount applied from a partial invoice + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param quantity [Float] Either the fixed fee quantity or the usage during the service period. + # + # @param start_date [Time] The start date of the range of time applied for this line item's price. + # + # @param sub_line_items [Array] For complex pricing structures, the line item can be broken down further in `sub + # ... + # + # @param subtotal [String] The line amount before before any adjustments. + # + # @param tax_amounts [Array] An array of tax rates and their incurred tax amounts. Empty if no tax integratio + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer ids that were used to calculate the usage for this line item. + # ... module Adjustment extend Orb::Internal::Type::Union @@ -1374,29 +1370,26 @@ class MonetaryUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # amount:, - # applies_to_price_ids:, - # is_invoice_level:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -1442,29 +1435,26 @@ class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, is_invoice_level:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -1510,29 +1500,26 @@ class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # amount:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -1584,31 +1571,28 @@ class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # amount:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -1654,34 +1638,30 @@ class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # amount:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment)] end # @deprecated @@ -1701,15 +1681,16 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # This field is deprecated in favor of `adjustments`. - # # - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum} for more details. + # + # This field is deprecated in favor of `adjustments`. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @deprecated @@ -1729,15 +1710,16 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # This field is deprecated in favor of `adjustments`. - # # - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum} for more details. + # + # This field is deprecated in favor of `adjustments`. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end module SubLineItem @@ -1788,17 +1770,18 @@ class MatrixSubLineItem < Orb::Internal::Type::BaseModel # @return [Symbol, :matrix] required :type, const: :matrix - # @!parse - # # @param amount [String] - # # @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::Grouping, nil] - # # @param matrix_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig] - # # @param name [String] - # # @param quantity [Float] - # # @param type [Symbol, :matrix] - # # - # def initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix) + # @param amount [String] The total amount for this sub line item. + # + # @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::Grouping, nil] + # + # @param matrix_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig] + # + # @param name [String] + # + # @param quantity [Float] + # + # @param type [Symbol, :matrix] # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem#grouping class Grouping < Orb::Internal::Type::BaseModel @@ -1813,13 +1796,10 @@ class Grouping < Orb::Internal::Type::BaseModel # @return [String, nil] required :value, String, nil?: true - # @!parse - # # @param key [String] - # # @param value [String, nil] - # # - # def initialize(key:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(key:, value:) + # @param key [String] + # + # @param value [String, nil] No value indicates the default group end # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem#matrix_config @@ -1830,12 +1810,8 @@ class MatrixConfig < Orb::Internal::Type::BaseModel # @return [Array] required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true] - # @!parse - # # @param dimension_values [Array] - # # - # def initialize(dimension_values:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:) + # @param dimension_values [Array] The ordered dimension values for this line item. end end @@ -1874,17 +1850,18 @@ class TierSubLineItem < Orb::Internal::Type::BaseModel # @return [Symbol, :tier] required :type, const: :tier - # @!parse - # # @param amount [String] - # # @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::Grouping, nil] - # # @param name [String] - # # @param quantity [Float] - # # @param tier_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::TierConfig] - # # @param type [Symbol, :tier] - # # - # def initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier) + # @param amount [String] The total amount for this sub line item. + # + # @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::Grouping, nil] + # + # @param name [String] + # + # @param quantity [Float] + # + # @param tier_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::TierConfig] + # + # @param type [Symbol, :tier] # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem#grouping class Grouping < Orb::Internal::Type::BaseModel @@ -1899,13 +1876,10 @@ class Grouping < Orb::Internal::Type::BaseModel # @return [String, nil] required :value, String, nil?: true - # @!parse - # # @param key [String] - # # @param value [String, nil] - # # - # def initialize(key:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(key:, value:) + # @param key [String] + # + # @param value [String, nil] No value indicates the default group end # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem#tier_config @@ -1925,14 +1899,10 @@ class TierConfig < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param first_unit [Float] - # # @param last_unit [Float, nil] - # # @param unit_amount [String] - # # - # def initialize(first_unit:, last_unit:, unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(first_unit:, last_unit:, unit_amount:) + # @param first_unit [Float] + # @param last_unit [Float, nil] + # @param unit_amount [String] end end @@ -1965,16 +1935,16 @@ class OtherSubLineItem < Orb::Internal::Type::BaseModel # @return [Symbol, :"'null'"] required :type, const: :"'null'" - # @!parse - # # @param amount [String] - # # @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem::Grouping, nil] - # # @param name [String] - # # @param quantity [Float] - # # @param type [Symbol, :"'null'"] - # # - # def initialize(amount:, grouping:, name:, quantity:, type: :"'null'", **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'") + # @param amount [String] The total amount for this sub line item. + # + # @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem::Grouping, nil] + # + # @param name [String] + # + # @param quantity [Float] + # + # @param type [Symbol, :"'null'"] # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem#grouping class Grouping < Orb::Internal::Type::BaseModel @@ -1989,19 +1959,15 @@ class Grouping < Orb::Internal::Type::BaseModel # @return [String, nil] required :value, String, nil?: true - # @!parse - # # @param key [String] - # # @param value [String, nil] - # # - # def initialize(key:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(key:, value:) + # @param key [String] + # + # @param value [String, nil] No value indicates the default group end end - # @!parse - # # @return [Array(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem)] end class TaxAmount < Orb::Internal::Type::BaseModel @@ -2023,14 +1989,12 @@ class TaxAmount < Orb::Internal::Type::BaseModel # @return [String, nil] required :tax_rate_percentage, String, nil?: true - # @!parse - # # @param amount [String] - # # @param tax_rate_description [String] - # # @param tax_rate_percentage [String, nil] - # # - # def initialize(amount:, tax_rate_description:, tax_rate_percentage:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:) + # @param amount [String] The amount of additional tax incurred by this tax rate. + # + # @param tax_rate_description [String] The human-readable description of the applied tax rate. + # + # @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100. end end @@ -2049,13 +2013,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceFetchUpcomingResponse::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::InvoiceFetchUpcomingResponse#minimum @@ -2073,13 +2038,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceFetchUpcomingResponse::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end class PaymentAttempt < Orb::Internal::Type::BaseModel @@ -2121,17 +2087,18 @@ class PaymentAttempt < Orb::Internal::Type::BaseModel # @return [Boolean] required :succeeded, Orb::Internal::Type::Boolean - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param created_at [Time] - # # @param payment_provider [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider, nil] - # # @param payment_provider_id [String, nil] - # # @param succeeded [Boolean] - # # - # def initialize(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:) + # @param id [String] The ID of the payment attempt. + # + # @param amount [String] The amount of the payment attempt. + # + # @param created_at [Time] The time at which the payment attempt was created. + # + # @param payment_provider [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider, nil] The payment provider that attempted to collect the payment. + # + # @param payment_provider_id [String, nil] The ID of the payment attempt in the payment provider. + # + # @param succeeded [Boolean] Whether the payment attempt succeeded. # The payment provider that attempted to collect the payment. # @@ -2141,11 +2108,8 @@ module PaymentProvider STRIPE = :stripe - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2181,17 +2145,13 @@ class ShippingAddress < Orb::Internal::Type::BaseModel # @return [String, nil] required :state, String, nil?: true - # @!parse - # # @param city [String, nil] - # # @param country [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:) + # @param city [String, nil] + # @param country [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end # @see Orb::Models::InvoiceFetchUpcomingResponse#status @@ -2204,11 +2164,8 @@ module Status VOID = :void DRAFT = :draft - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::InvoiceFetchUpcomingResponse#subscription @@ -2218,12 +2175,8 @@ class Subscription < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end end end diff --git a/lib/orb/models/invoice_issue_params.rb b/lib/orb/models/invoice_issue_params.rb index 662fd07b..bbfa9766 100644 --- a/lib/orb/models/invoice_issue_params.rb +++ b/lib/orb/models/invoice_issue_params.rb @@ -4,11 +4,10 @@ module Orb module Models # @see Orb::Resources::Invoices#issue class InvoiceIssueParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!attribute [r] synchronous + # @!attribute synchronous # If true, the invoice will be issued synchronously. If false, the invoice will be # issued asynchronously. The synchronous option is only available for invoices # that have no usage fees. If the invoice is configured to sync to an external @@ -18,17 +17,14 @@ class InvoiceIssueParams < Orb::Internal::Type::BaseModel # @return [Boolean, nil] optional :synchronous, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :synchronous - - # @!parse - # # @param synchronous [Boolean] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(synchronous: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(synchronous: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceIssueParams} for more details. + # + # @param synchronous [Boolean] If true, the invoice will be issued synchronously. If false, the invoice will be + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/invoice_level_discount.rb b/lib/orb/models/invoice_level_discount.rb index 7259f26e..5d60f9b4 100644 --- a/lib/orb/models/invoice_level_discount.rb +++ b/lib/orb/models/invoice_level_discount.rb @@ -13,9 +13,8 @@ module InvoiceLevelDiscount variant :trial, -> { Orb::Models::TrialDiscount } - # @!parse - # # @return [Array(Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount)] end end end diff --git a/lib/orb/models/invoice_line_item_create_params.rb b/lib/orb/models/invoice_line_item_create_params.rb index c15335fe..4e758269 100644 --- a/lib/orb/models/invoice_line_item_create_params.rb +++ b/lib/orb/models/invoice_line_item_create_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::InvoiceLineItems#create class InvoiceLineItemCreateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute amount @@ -45,18 +44,24 @@ class InvoiceLineItemCreateParams < Orb::Internal::Type::BaseModel # @return [Date] required :start_date, Date - # @!parse - # # @param amount [String] - # # @param end_date [Date] - # # @param invoice_id [String] - # # @param name [String] - # # @param quantity [Float] - # # @param start_date [Date] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(amount:, end_date:, invoice_id:, name:, quantity:, start_date:, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, end_date:, invoice_id:, name:, quantity:, start_date:, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceLineItemCreateParams} for more details. + # + # @param amount [String] The total amount in the invoice's currency to add to the line item. + # + # @param end_date [Date] A date string to specify the line item's end date in the customer's timezone. + # + # @param invoice_id [String] The id of the Invoice to add this line item. + # + # @param name [String] The item name associated with this line item. If an item with the same name exis + # ... + # + # @param quantity [Float] The number of units on the line item + # + # @param start_date [Date] A date string to specify the line item's start date in the customer's timezone. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/invoice_line_item_create_response.rb b/lib/orb/models/invoice_line_item_create_response.rb index cfeef37d..21add80f 100644 --- a/lib/orb/models/invoice_line_item_create_response.rb +++ b/lib/orb/models/invoice_line_item_create_response.rb @@ -65,24 +65,32 @@ class InvoiceLineItemCreateResponse < Orb::Internal::Type::BaseModel required :grouping, String, nil?: true # @!attribute maximum + # @deprecated + # # This field is deprecated in favor of `adjustments`. # # @return [Orb::Models::InvoiceLineItemCreateResponse::Maximum, nil] required :maximum, -> { Orb::Models::InvoiceLineItemCreateResponse::Maximum }, nil?: true # @!attribute maximum_amount + # @deprecated + # # This field is deprecated in favor of `adjustments`. # # @return [String, nil] required :maximum_amount, String, nil?: true # @!attribute minimum + # @deprecated + # # This field is deprecated in favor of `adjustments`. # # @return [Orb::Models::InvoiceLineItemCreateResponse::Minimum, nil] required :minimum, -> { Orb::Models::InvoiceLineItemCreateResponse::Minimum }, nil?: true # @!attribute minimum_amount + # @deprecated + # # This field is deprecated in favor of `adjustments`. # # @return [String, nil] @@ -155,59 +163,61 @@ class InvoiceLineItemCreateResponse < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # @param id [String] - # # @param adjusted_subtotal [String] - # # @param adjustments [Array] - # # @param amount [String] - # # @param credits_applied [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param end_date [Time] - # # @param filter [String, nil] - # # @param grouping [String, nil] - # # @param maximum [Orb::Models::InvoiceLineItemCreateResponse::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param minimum [Orb::Models::InvoiceLineItemCreateResponse::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param partially_invoiced_amount [String] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil] - # # @param quantity [Float] - # # @param start_date [Time] - # # @param sub_line_items [Array] - # # @param subtotal [String] - # # @param tax_amounts [Array] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # adjusted_subtotal:, - # adjustments:, - # amount:, - # credits_applied:, - # discount:, - # end_date:, - # filter:, - # grouping:, - # maximum:, - # maximum_amount:, - # minimum:, - # minimum_amount:, - # name:, - # partially_invoiced_amount:, - # price:, - # quantity:, - # start_date:, - # sub_line_items:, - # subtotal:, - # tax_amounts:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjusted_subtotal:, adjustments:, amount:, credits_applied:, discount:, end_date:, filter:, grouping:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, partially_invoiced_amount:, price:, quantity:, start_date:, sub_line_items:, subtotal:, tax_amounts:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceLineItemCreateResponse} for more details. + # + # @param id [String] A unique ID for this line item. + # + # @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and + # ... + # + # @param adjustments [Array] All adjustments applied to the line item in the order they were applied based on + # ... + # + # @param amount [String] The final amount for a line item after all adjustments and pre paid credits have + # ... + # + # @param credits_applied [String] The number of prepaid credits applied. + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param end_date [Time] The end date of the range of time applied for this line item's price. + # + # @param filter [String, nil] An additional filter that was used to calculate the usage for this line item. + # + # @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b + # ... + # + # @param maximum [Orb::Models::InvoiceLineItemCreateResponse::Maximum, nil] This field is deprecated in favor of `adjustments`. + # + # @param maximum_amount [String, nil] This field is deprecated in favor of `adjustments`. + # + # @param minimum [Orb::Models::InvoiceLineItemCreateResponse::Minimum, nil] This field is deprecated in favor of `adjustments`. + # + # @param minimum_amount [String, nil] This field is deprecated in favor of `adjustments`. + # + # @param name [String] The name of the price associated with this line item. + # + # @param partially_invoiced_amount [String] Any amount applied from a partial invoice + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param quantity [Float] Either the fixed fee quantity or the usage during the service period. + # + # @param start_date [Time] The start date of the range of time applied for this line item's price. + # + # @param sub_line_items [Array] For complex pricing structures, the line item can be broken down further in `sub + # ... + # + # @param subtotal [String] The line amount before before any adjustments. + # + # @param tax_amounts [Array] An array of tax rates and their incurred tax amounts. Empty if no tax integratio + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer ids that were used to calculate the usage for this line item. + # ... module Adjustment extend Orb::Internal::Type::Union @@ -270,29 +280,26 @@ class MonetaryUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # amount:, - # applies_to_price_ids:, - # is_invoice_level:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -338,29 +345,26 @@ class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, is_invoice_level:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -406,29 +410,26 @@ class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # amount:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -480,31 +481,28 @@ class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # amount:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -550,34 +548,30 @@ class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # amount:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount [String] The value applied by an adjustment. + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment)] end # @deprecated @@ -597,15 +591,16 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # This field is deprecated in favor of `adjustments`. - # # - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceLineItemCreateResponse::Maximum} for more details. + # + # This field is deprecated in favor of `adjustments`. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @deprecated @@ -625,15 +620,16 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # This field is deprecated in favor of `adjustments`. - # # - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceLineItemCreateResponse::Minimum} for more details. + # + # This field is deprecated in favor of `adjustments`. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end module SubLineItem @@ -682,17 +678,18 @@ class MatrixSubLineItem < Orb::Internal::Type::BaseModel # @return [Symbol, :matrix] required :type, const: :matrix - # @!parse - # # @param amount [String] - # # @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::Grouping, nil] - # # @param matrix_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::MatrixConfig] - # # @param name [String] - # # @param quantity [Float] - # # @param type [Symbol, :matrix] - # # - # def initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix) + # @param amount [String] The total amount for this sub line item. + # + # @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::Grouping, nil] + # + # @param matrix_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::MatrixConfig] + # + # @param name [String] + # + # @param quantity [Float] + # + # @param type [Symbol, :matrix] # @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem#grouping class Grouping < Orb::Internal::Type::BaseModel @@ -707,13 +704,10 @@ class Grouping < Orb::Internal::Type::BaseModel # @return [String, nil] required :value, String, nil?: true - # @!parse - # # @param key [String] - # # @param value [String, nil] - # # - # def initialize(key:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(key:, value:) + # @param key [String] + # + # @param value [String, nil] No value indicates the default group end # @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem#matrix_config @@ -724,12 +718,8 @@ class MatrixConfig < Orb::Internal::Type::BaseModel # @return [Array] required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true] - # @!parse - # # @param dimension_values [Array] - # # - # def initialize(dimension_values:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:) + # @param dimension_values [Array] The ordered dimension values for this line item. end end @@ -768,17 +758,18 @@ class TierSubLineItem < Orb::Internal::Type::BaseModel # @return [Symbol, :tier] required :type, const: :tier - # @!parse - # # @param amount [String] - # # @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::Grouping, nil] - # # @param name [String] - # # @param quantity [Float] - # # @param tier_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::TierConfig] - # # @param type [Symbol, :tier] - # # - # def initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier) + # @param amount [String] The total amount for this sub line item. + # + # @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::Grouping, nil] + # + # @param name [String] + # + # @param quantity [Float] + # + # @param tier_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::TierConfig] + # + # @param type [Symbol, :tier] # @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem#grouping class Grouping < Orb::Internal::Type::BaseModel @@ -793,13 +784,10 @@ class Grouping < Orb::Internal::Type::BaseModel # @return [String, nil] required :value, String, nil?: true - # @!parse - # # @param key [String] - # # @param value [String, nil] - # # - # def initialize(key:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(key:, value:) + # @param key [String] + # + # @param value [String, nil] No value indicates the default group end # @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem#tier_config @@ -819,14 +807,10 @@ class TierConfig < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param first_unit [Float] - # # @param last_unit [Float, nil] - # # @param unit_amount [String] - # # - # def initialize(first_unit:, last_unit:, unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(first_unit:, last_unit:, unit_amount:) + # @param first_unit [Float] + # @param last_unit [Float, nil] + # @param unit_amount [String] end end @@ -859,16 +843,16 @@ class OtherSubLineItem < Orb::Internal::Type::BaseModel # @return [Symbol, :"'null'"] required :type, const: :"'null'" - # @!parse - # # @param amount [String] - # # @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem::Grouping, nil] - # # @param name [String] - # # @param quantity [Float] - # # @param type [Symbol, :"'null'"] - # # - # def initialize(amount:, grouping:, name:, quantity:, type: :"'null'", **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'") + # @param amount [String] The total amount for this sub line item. + # + # @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem::Grouping, nil] + # + # @param name [String] + # + # @param quantity [Float] + # + # @param type [Symbol, :"'null'"] # @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem#grouping class Grouping < Orb::Internal::Type::BaseModel @@ -883,19 +867,15 @@ class Grouping < Orb::Internal::Type::BaseModel # @return [String, nil] required :value, String, nil?: true - # @!parse - # # @param key [String] - # # @param value [String, nil] - # # - # def initialize(key:, value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(key:, value:) + # @param key [String] + # + # @param value [String, nil] No value indicates the default group end end - # @!parse - # # @return [Array(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem)] end class TaxAmount < Orb::Internal::Type::BaseModel @@ -917,14 +897,12 @@ class TaxAmount < Orb::Internal::Type::BaseModel # @return [String, nil] required :tax_rate_percentage, String, nil?: true - # @!parse - # # @param amount [String] - # # @param tax_rate_description [String] - # # @param tax_rate_percentage [String, nil] - # # - # def initialize(amount:, tax_rate_description:, tax_rate_percentage:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:) + # @param amount [String] The amount of additional tax incurred by this tax rate. + # + # @param tax_rate_description [String] The human-readable description of the applied tax rate. + # + # @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100. end end end diff --git a/lib/orb/models/invoice_list_params.rb b/lib/orb/models/invoice_list_params.rb index d733b10f..41df13e6 100644 --- a/lib/orb/models/invoice_list_params.rb +++ b/lib/orb/models/invoice_list_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Invoices#list class InvoiceListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute amount @@ -94,16 +93,12 @@ class InvoiceListParams < Orb::Internal::Type::BaseModel # @return [Boolean, nil] optional :is_recurring, Orb::Internal::Type::Boolean, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - # @!attribute status # # @return [Array, nil] @@ -116,55 +111,51 @@ class InvoiceListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :subscription_id, String, nil?: true - # @!parse - # # @param amount [String, nil] - # # @param amount_gt [String, nil] - # # @param amount_lt [String, nil] - # # @param cursor [String, nil] - # # @param customer_id [String, nil] - # # @param date_type [Symbol, Orb::Models::InvoiceListParams::DateType, nil] - # # @param due_date [Date, nil] - # # @param due_date_window [String, nil] - # # @param due_date_gt [Date, nil] - # # @param due_date_lt [Date, nil] - # # @param external_customer_id [String, nil] - # # @param invoice_date_gt [Time, nil] - # # @param invoice_date_gte [Time, nil] - # # @param invoice_date_lt [Time, nil] - # # @param invoice_date_lte [Time, nil] - # # @param is_recurring [Boolean, nil] - # # @param limit [Integer] - # # @param status [Array, nil] - # # @param subscription_id [String, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # amount: nil, - # amount_gt: nil, - # amount_lt: nil, - # cursor: nil, - # customer_id: nil, - # date_type: nil, - # due_date: nil, - # due_date_window: nil, - # due_date_gt: nil, - # due_date_lt: nil, - # external_customer_id: nil, - # invoice_date_gt: nil, - # invoice_date_gte: nil, - # invoice_date_lt: nil, - # invoice_date_lte: nil, - # is_recurring: nil, - # limit: nil, - # status: nil, - # subscription_id: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount: nil, amount_gt: nil, amount_lt: nil, cursor: nil, customer_id: nil, date_type: nil, due_date: nil, due_date_window: nil, due_date_gt: nil, due_date_lt: nil, external_customer_id: nil, invoice_date_gt: nil, invoice_date_gte: nil, invoice_date_lt: nil, invoice_date_lte: nil, is_recurring: nil, limit: nil, status: nil, subscription_id: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceListParams} for more details. + # + # @param amount [String, nil] + # + # @param amount_gt [String, nil] + # + # @param amount_lt [String, nil] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param customer_id [String, nil] + # + # @param date_type [Symbol, Orb::Models::InvoiceListParams::DateType, nil] + # + # @param due_date [Date, nil] + # + # @param due_date_window [String, nil] Filters invoices by their due dates within a specific time range in the past. Sp + # ... + # + # @param due_date_gt [Date, nil] + # + # @param due_date_lt [Date, nil] + # + # @param external_customer_id [String, nil] + # + # @param invoice_date_gt [Time, nil] + # + # @param invoice_date_gte [Time, nil] + # + # @param invoice_date_lt [Time, nil] + # + # @param invoice_date_lte [Time, nil] + # + # @param is_recurring [Boolean, nil] + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param status [Array, nil] + # + # @param subscription_id [String, nil] + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] module DateType extend Orb::Internal::Type::Enum @@ -172,11 +163,8 @@ module DateType DUE_DATE = :due_date INVOICE_DATE = :invoice_date - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end module Status @@ -188,11 +176,8 @@ module Status SYNCED = :synced VOID = :void - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/invoice_mark_paid_params.rb b/lib/orb/models/invoice_mark_paid_params.rb index efe8fd2f..cce952c3 100644 --- a/lib/orb/models/invoice_mark_paid_params.rb +++ b/lib/orb/models/invoice_mark_paid_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Invoices#mark_paid class InvoiceMarkPaidParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute payment_received_date @@ -26,15 +25,14 @@ class InvoiceMarkPaidParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :notes, String, nil?: true - # @!parse - # # @param payment_received_date [Date] - # # @param external_id [String, nil] - # # @param notes [String, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(payment_received_date:, external_id: nil, notes: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(payment_received_date:, external_id: nil, notes: nil, request_options: {}) + # @param payment_received_date [Date] A date string to specify the date of the payment. + # + # @param external_id [String, nil] An optional external ID to associate with the payment. + # + # @param notes [String, nil] An optional note to associate with the payment. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/invoice_pay_params.rb b/lib/orb/models/invoice_pay_params.rb index 9b331332..08c4da4a 100644 --- a/lib/orb/models/invoice_pay_params.rb +++ b/lib/orb/models/invoice_pay_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Invoices#pay class InvoicePayParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/invoice_update_params.rb b/lib/orb/models/invoice_update_params.rb index cb0a0081..d67bc879 100644 --- a/lib/orb/models/invoice_update_params.rb +++ b/lib/orb/models/invoice_update_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Invoices#update class InvoiceUpdateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute metadata @@ -16,13 +15,14 @@ class InvoiceUpdateParams < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(metadata: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(metadata: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceUpdateParams} for more details. + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/invoice_void_params.rb b/lib/orb/models/invoice_void_params.rb index 911bf036..54a3dbeb 100644 --- a/lib/orb/models/invoice_void_params.rb +++ b/lib/orb/models/invoice_void_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Invoices#void class InvoiceVoidParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/item.rb b/lib/orb/models/item.rb index 0b54b210..5683b269 100644 --- a/lib/orb/models/item.rb +++ b/lib/orb/models/item.rb @@ -24,19 +24,15 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # The Item resource represents a sellable product or good. Items are associated - # # with all line items, billable metrics, and prices and are used for defining - # # external sync behavior for invoices and tax calculation purposes. - # # - # # @param id [String] - # # @param created_at [Time] - # # @param external_connections [Array] - # # @param name [String] - # # - # def initialize(id:, created_at:, external_connections:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, created_at:, external_connections:, name:) + # The Item resource represents a sellable product or good. Items are associated + # with all line items, billable metrics, and prices and are used for defining + # external sync behavior for invoices and tax calculation purposes. + # + # @param id [String] + # @param created_at [Time] + # @param external_connections [Array] + # @param name [String] class ExternalConnection < Orb::Internal::Type::BaseModel # @!attribute external_connection_name @@ -50,13 +46,9 @@ class ExternalConnection < Orb::Internal::Type::BaseModel # @return [String] required :external_entity_id, String - # @!parse - # # @param external_connection_name [Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName] - # # @param external_entity_id [String] - # # - # def initialize(external_connection_name:, external_entity_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(external_connection_name:, external_entity_id:) + # @param external_connection_name [Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName] + # @param external_entity_id [String] # @see Orb::Models::Item::ExternalConnection#external_connection_name module ExternalConnectionName @@ -70,11 +62,8 @@ module ExternalConnectionName AVALARA = :avalara ANROK = :anrok - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/item_create_params.rb b/lib/orb/models/item_create_params.rb index b4100556..4cf435bc 100644 --- a/lib/orb/models/item_create_params.rb +++ b/lib/orb/models/item_create_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Items#create class ItemCreateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute name @@ -14,13 +13,10 @@ class ItemCreateParams < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param name [String] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(name:, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(name:, request_options: {}) + # @param name [String] The name of the item. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/item_fetch_params.rb b/lib/orb/models/item_fetch_params.rb index f800e584..90e07247 100644 --- a/lib/orb/models/item_fetch_params.rb +++ b/lib/orb/models/item_fetch_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Items#fetch class ItemFetchParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/item_list_params.rb b/lib/orb/models/item_list_params.rb index bdbfb38d..644d4c8e 100644 --- a/lib/orb/models/item_list_params.rb +++ b/lib/orb/models/item_list_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Items#list class ItemListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute cursor @@ -15,24 +14,22 @@ class ItemListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, limit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::ItemListParams} for more details. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/item_update_params.rb b/lib/orb/models/item_update_params.rb index 007e7ad3..451d014f 100644 --- a/lib/orb/models/item_update_params.rb +++ b/lib/orb/models/item_update_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Items#update class ItemUpdateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute external_connections @@ -20,14 +19,10 @@ class ItemUpdateParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :name, String, nil?: true - # @!parse - # # @param external_connections [Array, nil] - # # @param name [String, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(external_connections: nil, name: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(external_connections: nil, name: nil, request_options: {}) + # @param external_connections [Array, nil] + # @param name [String, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] class ExternalConnection < Orb::Internal::Type::BaseModel # @!attribute external_connection_name @@ -41,13 +36,9 @@ class ExternalConnection < Orb::Internal::Type::BaseModel # @return [String] required :external_entity_id, String - # @!parse - # # @param external_connection_name [Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName] - # # @param external_entity_id [String] - # # - # def initialize(external_connection_name:, external_entity_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(external_connection_name:, external_entity_id:) + # @param external_connection_name [Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName] + # @param external_entity_id [String] # @see Orb::Models::ItemUpdateParams::ExternalConnection#external_connection_name module ExternalConnectionName @@ -61,11 +52,8 @@ module ExternalConnectionName AVALARA = :avalara ANROK = :anrok - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/metric_create_params.rb b/lib/orb/models/metric_create_params.rb index 201f4506..d03b7df9 100644 --- a/lib/orb/models/metric_create_params.rb +++ b/lib/orb/models/metric_create_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Metrics#create class MetricCreateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute description @@ -40,17 +39,22 @@ class MetricCreateParams < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param description [String, nil] - # # @param item_id [String] - # # @param name [String] - # # @param sql [String] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(description:, item_id:, name:, sql:, metadata: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(description:, item_id:, name:, sql:, metadata: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::MetricCreateParams} for more details. + # + # @param description [String, nil] A description of the metric. + # + # @param item_id [String] The id of the item + # + # @param name [String] The name of the metric. + # + # @param sql [String] A sql string defining the metric. + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/metric_fetch_params.rb b/lib/orb/models/metric_fetch_params.rb index 977bba86..68efa269 100644 --- a/lib/orb/models/metric_fetch_params.rb +++ b/lib/orb/models/metric_fetch_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Metrics#fetch class MetricFetchParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/metric_list_params.rb b/lib/orb/models/metric_list_params.rb index b00bee14..f2700334 100644 --- a/lib/orb/models/metric_list_params.rb +++ b/lib/orb/models/metric_list_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Metrics#list class MetricListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute created_at_gt @@ -35,39 +34,30 @@ class MetricListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param created_at_gt [Time, nil] - # # @param created_at_gte [Time, nil] - # # @param created_at_lt [Time, nil] - # # @param created_at_lte [Time, nil] - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # created_at_gt: nil, - # created_at_gte: nil, - # created_at_lt: nil, - # created_at_lte: nil, - # cursor: nil, - # limit: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::MetricListParams} for more details. + # + # @param created_at_gt [Time, nil] + # + # @param created_at_gte [Time, nil] + # + # @param created_at_lt [Time, nil] + # + # @param created_at_lte [Time, nil] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/metric_update_params.rb b/lib/orb/models/metric_update_params.rb index 36b97e44..0db5e6c2 100644 --- a/lib/orb/models/metric_update_params.rb +++ b/lib/orb/models/metric_update_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Metrics#update class MetricUpdateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute metadata @@ -16,13 +15,14 @@ class MetricUpdateParams < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(metadata: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(metadata: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::MetricUpdateParams} for more details. + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/pagination_metadata.rb b/lib/orb/models/pagination_metadata.rb index 908ba439..8e0dd649 100644 --- a/lib/orb/models/pagination_metadata.rb +++ b/lib/orb/models/pagination_metadata.rb @@ -13,13 +13,9 @@ class PaginationMetadata < Orb::Internal::Type::BaseModel # @return [String, nil] required :next_cursor, String, nil?: true - # @!parse - # # @param has_more [Boolean] - # # @param next_cursor [String, nil] - # # - # def initialize(has_more:, next_cursor:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(has_more:, next_cursor:) + # @param has_more [Boolean] + # @param next_cursor [String, nil] end end end diff --git a/lib/orb/models/percentage_discount.rb b/lib/orb/models/percentage_discount.rb index a56abe13..07044a49 100644 --- a/lib/orb/models/percentage_discount.rb +++ b/lib/orb/models/percentage_discount.rb @@ -27,15 +27,19 @@ class PercentageDiscount < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reason, String, nil?: true - # @!parse - # # @param applies_to_price_ids [Array] - # # @param discount_type [Symbol, Orb::Models::PercentageDiscount::DiscountType] - # # @param percentage_discount [Float] - # # @param reason [String, nil] - # # - # def initialize(applies_to_price_ids:, discount_type:, percentage_discount:, reason: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, discount_type:, percentage_discount:, reason: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::PercentageDiscount} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this discount applies to. For plan/plan phase discounts, + # ... + # + # @param discount_type [Symbol, Orb::Models::PercentageDiscount::DiscountType] + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`. This is a number between 0 and + # ... + # + # @param reason [String, nil] # @see Orb::Models::PercentageDiscount#discount_type module DiscountType @@ -43,11 +47,8 @@ module DiscountType PERCENTAGE = :percentage - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/plan.rb b/lib/orb/models/plan.rb index 0f943327..82492744 100644 --- a/lib/orb/models/plan.rb +++ b/lib/orb/models/plan.rb @@ -34,6 +34,8 @@ class Plan < Orb::Internal::Type::BaseModel required :created_at, Time # @!attribute currency + # @deprecated + # # An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's # prices. # @@ -148,68 +150,71 @@ class Plan < Orb::Internal::Type::BaseModel # @return [Integer] required :version, Integer - # @!parse - # # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # # subscribed to by a customer. Plans define the billing behavior of the - # # subscription. You can see more about how to configure prices in the - # # [Price resource](/reference/price). - # # - # # @param id [String] - # # @param adjustments [Array] - # # @param base_plan [Orb::Models::Plan::BasePlan, nil] - # # @param base_plan_id [String, nil] - # # @param created_at [Time] - # # @param currency [String] - # # @param default_invoice_memo [String, nil] - # # @param description [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_plan_id [String, nil] - # # @param invoicing_currency [String] - # # @param maximum [Orb::Models::Plan::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Plan::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param net_terms [Integer, nil] - # # @param plan_phases [Array, nil] - # # @param prices [Array] - # # @param product [Orb::Models::Plan::Product] - # # @param status [Symbol, Orb::Models::Plan::Status] - # # @param trial_config [Orb::Models::Plan::TrialConfig] - # # @param version [Integer] - # # - # def initialize( - # id:, - # adjustments:, - # base_plan:, - # base_plan_id:, - # created_at:, - # currency:, - # default_invoice_memo:, - # description:, - # discount:, - # external_plan_id:, - # invoicing_currency:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # net_terms:, - # plan_phases:, - # prices:, - # product:, - # status:, - # trial_config:, - # version:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustments:, base_plan:, base_plan_id:, created_at:, currency:, default_invoice_memo:, description:, discount:, external_plan_id:, invoicing_currency:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, net_terms:, plan_phases:, prices:, product:, status:, trial_config:, version:) + # Some parameter documentations has been truncated, see {Orb::Models::Plan} for + # more details. + # + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). + # + # @param id [String] + # + # @param adjustments [Array] Adjustments for this plan. If the plan has phases, this includes adjustments acr + # ... + # + # @param base_plan [Orb::Models::Plan::BasePlan, nil] + # + # @param base_plan_id [String, nil] The parent plan id if the given plan was created by overriding one or more of th + # ... + # + # @param created_at [Time] + # + # @param currency [String] An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's p + # ... + # + # @param default_invoice_memo [String, nil] The default memo text on the invoices corresponding to subscriptions on this pla + # ... + # + # @param description [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a + # ... + # + # @param invoicing_currency [String] An ISO 4217 currency string for which this plan is billed in. Matches `currency` + # ... + # + # @param maximum [Orb::Models::Plan::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Plan::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param net_terms [Integer, nil] Determines the difference between the invoice issue date and the due date. A val + # ... + # + # @param plan_phases [Array, nil] + # + # @param prices [Array] Prices for this plan. If the plan has phases, this includes prices across all ph + # ... + # + # @param product [Orb::Models::Plan::Product] + # + # @param status [Symbol, Orb::Models::Plan::Status] + # + # @param trial_config [Orb::Models::Plan::TrialConfig] + # + # @param version [Integer] module Adjustment extend Orb::Internal::Type::Union @@ -269,29 +274,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment} for more + # details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -337,29 +339,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment} for more + # details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -405,29 +404,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment} for more + # details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -479,31 +475,27 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment} for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -549,34 +541,29 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment} for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment)] end # @see Orb::Models::Plan#base_plan @@ -599,14 +586,16 @@ class BasePlan < Orb::Internal::Type::BaseModel # @return [String, nil] required :name, String, nil?: true - # @!parse - # # @param id [String, nil] - # # @param external_plan_id [String, nil] - # # @param name [String, nil] - # # - # def initialize(id:, external_plan_id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_plan_id:, name:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Plan::BasePlan} for more details. + # + # @param id [String, nil] + # + # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a + # ... + # + # @param name [String, nil] end # @see Orb::Models::Plan#maximum @@ -624,13 +613,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Plan::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Plan#minimum @@ -648,13 +638,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Plan::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end class PlanPhase < Orb::Internal::Type::BaseModel @@ -716,37 +707,32 @@ class PlanPhase < Orb::Internal::Type::BaseModel # @return [Integer] required :order, Integer - # @!parse - # # @param id [String] - # # @param description [String, nil] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param duration [Integer, nil] - # # @param duration_unit [Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil] - # # @param maximum [Orb::Models::Plan::PlanPhase::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param minimum [Orb::Models::Plan::PlanPhase::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param order [Integer] - # # - # def initialize( - # id:, - # description:, - # discount:, - # duration:, - # duration_unit:, - # maximum:, - # maximum_amount:, - # minimum:, - # minimum_amount:, - # name:, - # order:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, description:, discount:, duration:, duration_unit:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, order:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Plan::PlanPhase} for more details. + # + # @param id [String] + # + # @param description [String, nil] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param duration [Integer, nil] How many terms of length `duration_unit` this phase is active for. If null, this + # ... + # + # @param duration_unit [Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil] + # + # @param maximum [Orb::Models::Plan::PlanPhase::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param minimum [Orb::Models::Plan::PlanPhase::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param order [Integer] Determines the ordering of the phase in a plan's lifecycle. 1 = first phase. # @see Orb::Models::Plan::PlanPhase#duration_unit module DurationUnit @@ -758,11 +744,8 @@ module DurationUnit SEMI_ANNUAL = :semi_annual ANNUAL = :annual - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Plan::PlanPhase#maximum @@ -780,13 +763,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Plan::PlanPhase::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Plan::PlanPhase#minimum @@ -804,13 +788,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Plan::PlanPhase::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end end @@ -831,14 +816,10 @@ class Product < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param created_at [Time] - # # @param name [String] - # # - # def initialize(id:, created_at:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, created_at:, name:) + # @param id [String] + # @param created_at [Time] + # @param name [String] end # @see Orb::Models::Plan#status @@ -849,11 +830,8 @@ module Status ARCHIVED = :archived DRAFT = :draft - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Plan#trial_config @@ -868,13 +846,9 @@ class TrialConfig < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit] required :trial_period_unit, enum: -> { Orb::Models::Plan::TrialConfig::TrialPeriodUnit } - # @!parse - # # @param trial_period [Integer, nil] - # # @param trial_period_unit [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit] - # # - # def initialize(trial_period:, trial_period_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(trial_period:, trial_period_unit:) + # @param trial_period [Integer, nil] + # @param trial_period_unit [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit] # @see Orb::Models::Plan::TrialConfig#trial_period_unit module TrialPeriodUnit @@ -882,11 +856,8 @@ module TrialPeriodUnit DAYS = :days - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/plan_create_params.rb b/lib/orb/models/plan_create_params.rb index d659f4a3..721e5fc5 100644 --- a/lib/orb/models/plan_create_params.rb +++ b/lib/orb/models/plan_create_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Plans#create class PlanCreateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute currency @@ -54,44 +53,40 @@ class PlanCreateParams < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :net_terms, Integer, nil?: true - # @!attribute [r] status + # @!attribute status # The status of the plan to create (either active or draft). If not specified, # this defaults to active. # # @return [Symbol, Orb::Models::PlanCreateParams::Status, nil] optional :status, enum: -> { Orb::Models::PlanCreateParams::Status } - # @!parse - # # @return [Symbol, Orb::Models::PlanCreateParams::Status] - # attr_writer :status - - # @!parse - # # @param currency [String] - # # @param name [String] - # # @param prices [Array] - # # @param default_invoice_memo [String, nil] - # # @param external_plan_id [String, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param net_terms [Integer, nil] - # # @param status [Symbol, Orb::Models::PlanCreateParams::Status] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # currency:, - # name:, - # prices:, - # default_invoice_memo: nil, - # external_plan_id: nil, - # metadata: nil, - # net_terms: nil, - # status: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(currency:, name:, prices:, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, status: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams} for more details. + # + # @param currency [String] An ISO 4217 currency string for invoices generated by subscriptions on this plan + # ... + # + # @param name [String] + # + # @param prices [Array] Prices for this plan. If the plan has phases, this includes prices across all ph + # ... + # + # @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal. + # ... + # + # @param external_plan_id [String, nil] + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d + # ... + # + # @param status [Symbol, Orb::Models::PlanCreateParams::Status] The status of the plan to create (either active or draft). If not specified, thi + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] module Price extend Orb::Internal::Type::Union @@ -259,45 +254,46 @@ class NewPlanUnitPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_config [Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::UnitConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :unit] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :unit, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice} for more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_config [Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::UnitConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :unit] # The cadence to bill for this price on. # @@ -312,11 +308,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice#unit_config @@ -327,12 +320,8 @@ class UnitConfig < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param unit_amount [String] - # # - # def initialize(unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:) + # @param unit_amount [String] Rate per unit of usage end # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice#billing_cycle_configuration @@ -350,16 +339,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -370,11 +356,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -393,16 +376,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -413,11 +393,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -523,45 +500,46 @@ class NewPlanPackagePrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param package_config [Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::PackageConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :package] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # package_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice} for more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param package_config [Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::PackageConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :package] # The cadence to bill for this price on. # @@ -576,11 +554,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice#package_config @@ -598,13 +573,15 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @return [Integer] required :package_size, Integer - # @!parse - # # @param package_amount [String] - # # @param package_size [Integer] - # # - # def initialize(package_amount:, package_size:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(package_amount:, package_size:) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::PackageConfig} for + # more details. + # + # @param package_amount [String] A currency amount to rate usage by + # + # @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide + # ... end # @see Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice#billing_cycle_configuration @@ -622,16 +599,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -642,11 +616,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -665,16 +636,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -685,11 +653,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -795,45 +760,46 @@ class NewPlanMatrixPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence] - # # @param item_id [String] - # # @param matrix_config [Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::MatrixConfig] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :matrix] - # # - # def initialize( - # cadence:, - # item_id:, - # matrix_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :matrix, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, matrix_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice} for more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param matrix_config [Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::MatrixConfig] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :matrix] # The cadence to bill for this price on. # @@ -848,11 +814,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice#matrix_config @@ -876,14 +839,12 @@ class MatrixConfig < Orb::Internal::Type::BaseModel required :matrix_values, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::MatrixConfig::MatrixValue] } - # @!parse - # # @param default_unit_amount [String] - # # @param dimensions [Array] - # # @param matrix_values [Array] - # # - # def initialize(default_unit_amount:, dimensions:, matrix_values:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(default_unit_amount:, dimensions:, matrix_values:) + # @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value + # + # @param dimensions [Array] One or two event property values to evaluate matrix groups by + # + # @param matrix_values [Array] Matrix values for specified matrix grouping keys class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values @@ -900,13 +861,15 @@ class MatrixValue < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param dimension_values [Array] - # # @param unit_amount [String] - # # - # def initialize(dimension_values:, unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, unit_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::MatrixConfig::MatrixValue} + # for more details. + # + # @param dimension_values [Array] One or two matrix keys to filter usage to this Matrix value by. For example, ["r + # ... + # + # @param unit_amount [String] Unit price for the specified dimension_values end end @@ -925,16 +888,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -945,11 +905,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -968,16 +925,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -988,11 +942,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1098,45 +1049,46 @@ class NewPlanTieredPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_config [Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::TieredConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :tiered] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :tiered, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice} for more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_config [Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::TieredConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :tiered] # The cadence to bill for this price on. # @@ -1151,11 +1103,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice#tiered_config @@ -1167,12 +1116,8 @@ class TieredConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::TieredConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Tiers for rating based on total usage quantities into the specified tier class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit @@ -1193,14 +1138,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :last_unit, Float, nil?: true - # @!parse - # # @param first_unit [Float] - # # @param unit_amount [String] - # # @param last_unit [Float, nil] - # # - # def initialize(first_unit:, unit_amount:, last_unit: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(first_unit:, unit_amount:, last_unit: nil) + # @param first_unit [Float] Exclusive tier starting value + # + # @param unit_amount [String] Amount per unit + # + # @param last_unit [Float, nil] Inclusive tier ending value. If null, this is treated as the last tier end end @@ -1219,16 +1162,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1239,11 +1179,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1262,16 +1199,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1282,11 +1216,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1393,45 +1324,46 @@ class NewPlanTieredBpsPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_bps_config [Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :tiered_bps] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_bps_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :tiered_bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice} for more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_bps_config [Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :tiered_bps] # The cadence to bill for this price on. # @@ -1446,11 +1378,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice#tiered_bps_config @@ -1463,12 +1392,13 @@ class TieredBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig} + # for more details. + # + # @param tiers [Array] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -1495,15 +1425,14 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param minimum_amount [String] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Per-event basis point rate + # + # @param minimum_amount [String] Exclusive tier starting value + # + # @param maximum_amount [String, nil] Inclusive tier ending value + # + # @param per_unit_maximum [String, nil] Per unit maximum to charge end end @@ -1522,16 +1451,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1542,11 +1468,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1565,16 +1488,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1585,11 +1505,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1695,45 +1612,46 @@ class NewPlanBpsPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param bps_config [Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BpsConfig] - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :bps] - # # - # def initialize( - # bps_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice} for more details. + # + # @param bps_config [Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BpsConfig] + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :bps] # @see Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice#bps_config class BpsConfig < Orb::Internal::Type::BaseModel @@ -1749,13 +1667,10 @@ class BpsConfig < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, per_unit_maximum: nil) + # @param bps [Float] Basis point take rate per event + # + # @param per_unit_maximum [String, nil] Optional currency amount maximum to cap spend per event end # The cadence to bill for this price on. @@ -1771,11 +1686,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice#billing_cycle_configuration @@ -1793,16 +1705,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1813,11 +1722,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1836,16 +1742,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1856,11 +1759,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1966,45 +1866,46 @@ class NewPlanBulkBpsPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param bulk_bps_config [Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig] - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :bulk_bps] - # # - # def initialize( - # bulk_bps_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :bulk_bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice} for more details. + # + # @param bulk_bps_config [Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig] + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :bulk_bps] # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice#bulk_bps_config class BulkBpsConfig < Orb::Internal::Type::BaseModel @@ -2016,12 +1917,13 @@ class BulkBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig} for + # more details. + # + # @param tiers [Array] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -2042,14 +1944,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Basis points to rate on + # + # @param maximum_amount [String, nil] Upper bound for tier + # + # @param per_unit_maximum [String, nil] The maximum amount to charge for any one event end end @@ -2066,11 +1966,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice#billing_cycle_configuration @@ -2088,16 +1985,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2108,11 +2002,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2131,16 +2022,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2151,11 +2039,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2261,45 +2146,46 @@ class NewPlanBulkPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param bulk_config [Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BulkConfig] - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :bulk] - # # - # def initialize( - # bulk_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :bulk, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice} for more details. + # + # @param bulk_config [Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BulkConfig] + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :bulk] # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice#bulk_config class BulkConfig < Orb::Internal::Type::BaseModel @@ -2310,12 +2196,8 @@ class BulkConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BulkConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Bulk tiers for rating based on total usage volume class Tier < Orb::Internal::Type::BaseModel # @!attribute unit_amount @@ -2330,13 +2212,10 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :maximum_units, Float, nil?: true - # @!parse - # # @param unit_amount [String] - # # @param maximum_units [Float, nil] - # # - # def initialize(unit_amount:, maximum_units: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:, maximum_units: nil) + # @param unit_amount [String] Amount per unit + # + # @param maximum_units [Float, nil] Upper bound for this tier end end @@ -2353,11 +2232,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice#billing_cycle_configuration @@ -2375,16 +2251,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2395,11 +2268,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2418,16 +2288,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2438,11 +2305,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2549,45 +2413,47 @@ class NewPlanThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param threshold_total_amount_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :threshold_total_amount] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # threshold_total_amount_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :threshold_total_amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, threshold_total_amount_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :threshold_total_amount) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice} for + # more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param threshold_total_amount_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :threshold_total_amount] # The cadence to bill for this price on. # @@ -2602,11 +2468,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice#billing_cycle_configuration @@ -2624,16 +2487,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2644,11 +2504,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2667,16 +2524,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2687,11 +2541,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2797,46 +2648,48 @@ class NewPlanTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_package_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :tiered_package] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_package_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void - + # @!method initialize(cadence:, item_id:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice} for more + # details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_package_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :tiered_package] + # The cadence to bill for this price on. # # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice#cadence @@ -2850,11 +2703,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice#billing_cycle_configuration @@ -2872,16 +2722,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2892,11 +2739,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2915,16 +2759,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2935,11 +2776,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3046,45 +2884,47 @@ class NewPlanTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_with_minimum_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :tiered_with_minimum] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_with_minimum_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :tiered_with_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice} for more + # details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_with_minimum_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :tiered_with_minimum] # The cadence to bill for this price on. # @@ -3099,11 +2939,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice#billing_cycle_configuration @@ -3121,16 +2958,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3141,11 +2975,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3164,16 +2995,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3184,11 +3012,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3294,45 +3119,47 @@ class NewPlanUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_with_percent_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :unit_with_percent] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_with_percent_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :unit_with_percent, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_percent) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice} for more + # details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_with_percent_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :unit_with_percent] # The cadence to bill for this price on. # @@ -3347,11 +3174,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice#billing_cycle_configuration @@ -3369,16 +3193,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3389,11 +3210,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3412,16 +3230,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3432,11 +3247,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3543,45 +3355,47 @@ class NewPlanPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param package_with_allocation_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :package_with_allocation] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # package_with_allocation_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :package_with_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, package_with_allocation_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package_with_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice} for + # more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param package_with_allocation_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :package_with_allocation] # The cadence to bill for this price on. # @@ -3596,11 +3410,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice#billing_cycle_configuration @@ -3618,16 +3429,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3638,11 +3446,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3661,16 +3466,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3681,11 +3483,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3792,45 +3591,47 @@ class NewPlanTierWithProrationPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_with_proration_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :tiered_with_proration] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_with_proration_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :tiered_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice} for more + # details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_with_proration_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :tiered_with_proration] # The cadence to bill for this price on. # @@ -3845,11 +3646,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice#billing_cycle_configuration @@ -3867,16 +3665,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3887,11 +3682,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3910,16 +3702,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3930,11 +3719,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4041,45 +3827,47 @@ class NewPlanUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_with_proration_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :unit_with_proration] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_with_proration_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :unit_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice} for more + # details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_with_proration_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :unit_with_proration] # The cadence to bill for this price on. # @@ -4094,11 +3882,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice#billing_cycle_configuration @@ -4116,16 +3901,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4136,11 +3918,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4159,16 +3938,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4179,11 +3955,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4290,45 +4063,47 @@ class NewPlanGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence] - # # @param grouped_allocation_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :grouped_allocation] - # # - # def initialize( - # cadence:, - # grouped_allocation_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :grouped_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_allocation_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice} for more + # details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_allocation_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :grouped_allocation] # The cadence to bill for this price on. # @@ -4343,11 +4118,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice#billing_cycle_configuration @@ -4365,16 +4137,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4385,11 +4154,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4408,16 +4174,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4428,11 +4191,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4540,45 +4300,47 @@ class NewPlanGroupedWithProratedMinimumPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::Cadence] - # # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :grouped_with_prorated_minimum] - # # - # def initialize( - # cadence:, - # grouped_with_prorated_minimum_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :grouped_with_prorated_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_with_prorated_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_with_prorated_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :grouped_with_prorated_minimum] # The cadence to bill for this price on. # @@ -4593,11 +4355,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice#billing_cycle_configuration @@ -4615,16 +4374,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4635,11 +4391,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4658,16 +4411,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4678,11 +4428,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4790,45 +4537,47 @@ class NewPlanGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::Cadence] - # # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :grouped_with_metered_minimum] - # # - # def initialize( - # cadence:, - # grouped_with_metered_minimum_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :grouped_with_metered_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_with_metered_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_with_metered_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :grouped_with_metered_minimum] # The cadence to bill for this price on. # @@ -4843,11 +4592,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice#billing_cycle_configuration @@ -4865,16 +4611,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4885,11 +4628,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4908,16 +4648,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4928,11 +4665,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5039,45 +4773,47 @@ class NewPlanMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::Cadence] - # # @param item_id [String] - # # @param matrix_with_display_name_config [Hash{Symbol=>Object}] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :matrix_with_display_name] - # # - # def initialize( - # cadence:, - # item_id:, - # matrix_with_display_name_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :matrix_with_display_name, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, matrix_with_display_name_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix_with_display_name) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice} for + # more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param matrix_with_display_name_config [Hash{Symbol=>Object}] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :matrix_with_display_name] # The cadence to bill for this price on. # @@ -5092,11 +4828,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice#billing_cycle_configuration @@ -5114,16 +4847,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5134,11 +4864,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5157,16 +4884,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5177,11 +4901,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5288,45 +5009,47 @@ class NewPlanBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param bulk_with_proration_config [Hash{Symbol=>Object}] - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :bulk_with_proration] - # # - # def initialize( - # bulk_with_proration_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :bulk_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_with_proration_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice} for more + # details. + # + # @param bulk_with_proration_config [Hash{Symbol=>Object}] + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :bulk_with_proration] # The cadence to bill for this price on. # @@ -5341,11 +5064,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice#billing_cycle_configuration @@ -5363,16 +5083,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5383,11 +5100,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5406,16 +5120,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5426,11 +5137,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5537,45 +5245,47 @@ class NewPlanGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::Cadence] - # # @param grouped_tiered_package_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :grouped_tiered_package] - # # - # def initialize( - # cadence:, - # grouped_tiered_package_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :grouped_tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_tiered_package_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice} for + # more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_tiered_package_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :grouped_tiered_package] # The cadence to bill for this price on. # @@ -5590,11 +5300,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice#billing_cycle_configuration @@ -5612,16 +5319,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5632,11 +5336,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5655,16 +5356,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5675,11 +5373,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5786,45 +5481,47 @@ class NewPlanMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::Cadence] - # # @param item_id [String] - # # @param max_group_tiered_package_config [Hash{Symbol=>Object}] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :max_group_tiered_package] - # # - # def initialize( - # cadence:, - # item_id:, - # max_group_tiered_package_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :max_group_tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, max_group_tiered_package_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :max_group_tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice} for + # more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param max_group_tiered_package_config [Hash{Symbol=>Object}] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :max_group_tiered_package] # The cadence to bill for this price on. # @@ -5839,11 +5536,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice#billing_cycle_configuration @@ -5861,16 +5555,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5881,11 +5572,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5904,16 +5592,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5924,11 +5609,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6036,45 +5718,47 @@ class NewPlanScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :scalable_matrix_with_unit_pricing] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # scalable_matrix_with_unit_pricing_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :scalable_matrix_with_unit_pricing, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_unit_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :scalable_matrix_with_unit_pricing) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :scalable_matrix_with_unit_pricing] # The cadence to bill for this price on. # @@ -6089,11 +5773,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice#billing_cycle_configuration @@ -6111,16 +5792,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6131,11 +5809,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6154,16 +5829,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6174,11 +5846,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6286,45 +5955,47 @@ class NewPlanScalableMatrixWithTieredPricingPrice < Orb::Internal::Type::BaseMod # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :scalable_matrix_with_tiered_pricing] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # scalable_matrix_with_tiered_pricing_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :scalable_matrix_with_tiered_pricing, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_tiered_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :scalable_matrix_with_tiered_pricing) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :scalable_matrix_with_tiered_pricing] # The cadence to bill for this price on. # @@ -6339,11 +6010,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice#billing_cycle_configuration @@ -6361,16 +6029,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6381,11 +6046,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6404,16 +6066,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6424,11 +6083,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6535,45 +6191,47 @@ class NewPlanCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::Cadence] - # # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :cumulative_grouped_bulk] - # # - # def initialize( - # cadence:, - # cumulative_grouped_bulk_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :cumulative_grouped_bulk, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, cumulative_grouped_bulk_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :cumulative_grouped_bulk) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice} for + # more details. + # + # @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::Cadence] The cadence to bill for this price on. + # + # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :cumulative_grouped_bulk] # The cadence to bill for this price on. # @@ -6588,11 +6246,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice#billing_cycle_configuration @@ -6610,16 +6265,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6630,11 +6282,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6653,16 +6302,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6673,18 +6319,14 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end - # @!parse - # # @return [Array(Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice)] end # The status of the plan to create (either active or draft). If not specified, @@ -6695,11 +6337,8 @@ module Status ACTIVE = :active DRAFT = :draft - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/plan_fetch_params.rb b/lib/orb/models/plan_fetch_params.rb index 71913888..45ef1f06 100644 --- a/lib/orb/models/plan_fetch_params.rb +++ b/lib/orb/models/plan_fetch_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Plans#fetch class PlanFetchParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/plan_list_params.rb b/lib/orb/models/plan_list_params.rb index f931e614..8eb6fb06 100644 --- a/lib/orb/models/plan_list_params.rb +++ b/lib/orb/models/plan_list_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Plans#list class PlanListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute created_at_gt @@ -35,51 +34,38 @@ class PlanListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # The plan status to filter to ('active', 'archived', or 'draft'). # # @return [Symbol, Orb::Models::PlanListParams::Status, nil] optional :status, enum: -> { Orb::Models::PlanListParams::Status } - # @!parse - # # @return [Symbol, Orb::Models::PlanListParams::Status] - # attr_writer :status - - # @!parse - # # @param created_at_gt [Time, nil] - # # @param created_at_gte [Time, nil] - # # @param created_at_lt [Time, nil] - # # @param created_at_lte [Time, nil] - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param status [Symbol, Orb::Models::PlanListParams::Status] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # created_at_gt: nil, - # created_at_gte: nil, - # created_at_lt: nil, - # created_at_lte: nil, - # cursor: nil, - # limit: nil, - # status: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, status: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanListParams} for more details. + # + # @param created_at_gt [Time, nil] + # + # @param created_at_gte [Time, nil] + # + # @param created_at_lt [Time, nil] + # + # @param created_at_lte [Time, nil] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param status [Symbol, Orb::Models::PlanListParams::Status] The plan status to filter to ('active', 'archived', or 'draft'). + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] # The plan status to filter to ('active', 'archived', or 'draft'). module Status @@ -89,11 +75,8 @@ module Status ARCHIVED = :archived DRAFT = :draft - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/plan_update_params.rb b/lib/orb/models/plan_update_params.rb index 05646396..8a57e1a1 100644 --- a/lib/orb/models/plan_update_params.rb +++ b/lib/orb/models/plan_update_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Plans#update class PlanUpdateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute external_plan_id @@ -24,14 +23,17 @@ class PlanUpdateParams < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param external_plan_id [String, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(external_plan_id: nil, metadata: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(external_plan_id: nil, metadata: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanUpdateParams} for more details. + # + # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/plans/external_plan_id_fetch_params.rb b/lib/orb/models/plans/external_plan_id_fetch_params.rb index ae23f1f9..1944b37d 100644 --- a/lib/orb/models/plans/external_plan_id_fetch_params.rb +++ b/lib/orb/models/plans/external_plan_id_fetch_params.rb @@ -5,16 +5,11 @@ module Models module Plans # @see Orb::Resources::Plans::ExternalPlanID#fetch class ExternalPlanIDFetchParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/plans/external_plan_id_update_params.rb b/lib/orb/models/plans/external_plan_id_update_params.rb index 6cf93aa8..9edd220c 100644 --- a/lib/orb/models/plans/external_plan_id_update_params.rb +++ b/lib/orb/models/plans/external_plan_id_update_params.rb @@ -5,8 +5,7 @@ module Models module Plans # @see Orb::Resources::Plans::ExternalPlanID#update class ExternalPlanIDUpdateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute external_plan_id @@ -25,14 +24,17 @@ class ExternalPlanIDUpdateParams < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param external_plan_id [String, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(external_plan_id: nil, metadata: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(external_plan_id: nil, metadata: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Plans::ExternalPlanIDUpdateParams} for more details. + # + # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/price.rb b/lib/orb/models/price.rb index 398f692e..eeb55cc4 100644 --- a/lib/orb/models/price.rb +++ b/lib/orb/models/price.rb @@ -205,63 +205,58 @@ class UnitPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::UnitPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::UnitPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::UnitPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::UnitPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::UnitPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::UnitPrice::Item] - # # @param maximum [Orb::Models::Price::UnitPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::UnitPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::UnitPrice::PriceType] - # # @param unit_config [Orb::Models::Price::UnitPrice::UnitConfig] - # # @param dimensional_price_configuration [Orb::Models::Price::UnitPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :unit] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # unit_config:, - # dimensional_price_configuration: nil, - # model_type: :unit, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, unit_config:, dimensional_price_configuration: nil, model_type: :unit) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::UnitPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::UnitPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::UnitPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::UnitPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::UnitPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::UnitPrice::Item] + # + # @param maximum [Orb::Models::Price::UnitPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::UnitPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::UnitPrice::PriceType] + # + # @param unit_config [Orb::Models::Price::UnitPrice::UnitConfig] + # + # @param dimensional_price_configuration [Orb::Models::Price::UnitPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :unit] # @see Orb::Models::Price::UnitPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -270,12 +265,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::UnitPrice#billing_cycle_configuration @@ -291,13 +282,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::UnitPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::UnitPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::UnitPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::UnitPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -306,11 +293,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -325,11 +309,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::UnitPrice#credit_allocation @@ -344,13 +325,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::UnitPrice#invoicing_cycle_configuration @@ -366,13 +343,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -381,11 +354,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -401,13 +371,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::UnitPrice#maximum @@ -425,13 +391,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::UnitPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::UnitPrice#minimum @@ -449,13 +416,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::UnitPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::UnitPrice#price_type @@ -465,11 +433,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::UnitPrice#unit_config @@ -480,12 +445,8 @@ class UnitConfig < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param unit_amount [String] - # # - # def initialize(unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:) + # @param unit_amount [String] Rate per unit of usage end # @see Orb::Models::Price::UnitPrice#dimensional_price_configuration @@ -500,13 +461,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -639,63 +596,58 @@ class PackagePrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::PackagePrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::PackagePrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::PackagePrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::PackagePrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::PackagePrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::PackagePrice::Item] - # # @param maximum [Orb::Models::Price::PackagePrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::PackagePrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param package_config [Orb::Models::Price::PackagePrice::PackageConfig] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::PackagePrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::PackagePrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :package] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # package_config:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, package_config:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :package) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::PackagePrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::PackagePrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::PackagePrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::PackagePrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::PackagePrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::PackagePrice::Item] + # + # @param maximum [Orb::Models::Price::PackagePrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::PackagePrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param package_config [Orb::Models::Price::PackagePrice::PackageConfig] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::PackagePrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::PackagePrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :package] # @see Orb::Models::Price::PackagePrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -704,12 +656,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::PackagePrice#billing_cycle_configuration @@ -725,13 +673,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::PackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::PackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::PackagePrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::PackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -740,11 +684,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -759,11 +700,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::PackagePrice#credit_allocation @@ -778,13 +716,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::PackagePrice#invoicing_cycle_configuration @@ -800,13 +734,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -815,11 +745,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -835,13 +762,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::PackagePrice#maximum @@ -859,13 +782,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::PackagePrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::PackagePrice#minimum @@ -883,13 +807,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::PackagePrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::PackagePrice#package_config @@ -907,13 +832,14 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @return [Integer] required :package_size, Integer - # @!parse - # # @param package_amount [String] - # # @param package_size [Integer] - # # - # def initialize(package_amount:, package_size:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(package_amount:, package_size:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::PackagePrice::PackageConfig} for more details. + # + # @param package_amount [String] A currency amount to rate usage by + # + # @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide + # ... end # @see Orb::Models::Price::PackagePrice#price_type @@ -923,11 +849,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::PackagePrice#dimensional_price_configuration @@ -942,13 +865,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -1081,63 +1000,58 @@ class MatrixPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::MatrixPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::MatrixPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::MatrixPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::MatrixPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::MatrixPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::MatrixPrice::Item] - # # @param matrix_config [Orb::Models::Price::MatrixPrice::MatrixConfig] - # # @param maximum [Orb::Models::Price::MatrixPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::MatrixPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::MatrixPrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::MatrixPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :matrix] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # matrix_config:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :matrix, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, matrix_config:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :matrix) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::MatrixPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::MatrixPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::MatrixPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::MatrixPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::MatrixPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::MatrixPrice::Item] + # + # @param matrix_config [Orb::Models::Price::MatrixPrice::MatrixConfig] + # + # @param maximum [Orb::Models::Price::MatrixPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::MatrixPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::MatrixPrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::MatrixPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :matrix] # @see Orb::Models::Price::MatrixPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -1146,12 +1060,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::MatrixPrice#billing_cycle_configuration @@ -1167,13 +1077,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::MatrixPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::MatrixPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::MatrixPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::MatrixPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -1182,11 +1088,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1201,11 +1104,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::MatrixPrice#credit_allocation @@ -1220,13 +1120,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::MatrixPrice#invoicing_cycle_configuration @@ -1242,13 +1138,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -1257,11 +1149,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1277,13 +1166,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::MatrixPrice#matrix_config @@ -1307,14 +1192,12 @@ class MatrixConfig < Orb::Internal::Type::BaseModel required :matrix_values, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Price::MatrixPrice::MatrixConfig::MatrixValue] } - # @!parse - # # @param default_unit_amount [String] - # # @param dimensions [Array] - # # @param matrix_values [Array] - # # - # def initialize(default_unit_amount:, dimensions:, matrix_values:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(default_unit_amount:, dimensions:, matrix_values:) + # @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value + # + # @param dimensions [Array] One or two event property values to evaluate matrix groups by + # + # @param matrix_values [Array] Matrix values for specified matrix grouping keys class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values @@ -1331,13 +1214,14 @@ class MatrixValue < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param dimension_values [Array] - # # @param unit_amount [String] - # # - # def initialize(dimension_values:, unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, unit_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::MatrixPrice::MatrixConfig::MatrixValue} for more details. + # + # @param dimension_values [Array] One or two matrix keys to filter usage to this Matrix value by. For example, ["r + # ... + # + # @param unit_amount [String] Unit price for the specified dimension_values end end @@ -1356,13 +1240,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::MatrixPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::MatrixPrice#minimum @@ -1380,13 +1265,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::MatrixPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::MatrixPrice#price_type @@ -1396,11 +1282,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::MatrixPrice#dimensional_price_configuration @@ -1415,13 +1298,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -1554,63 +1433,58 @@ class TieredPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::TieredPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::TieredPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::TieredPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::TieredPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::TieredPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::TieredPrice::Item] - # # @param maximum [Orb::Models::Price::TieredPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::TieredPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::TieredPrice::PriceType] - # # @param tiered_config [Orb::Models::Price::TieredPrice::TieredConfig] - # # @param dimensional_price_configuration [Orb::Models::Price::TieredPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :tiered] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # tiered_config:, - # dimensional_price_configuration: nil, - # model_type: :tiered, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, tiered_config:, dimensional_price_configuration: nil, model_type: :tiered) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::TieredPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::TieredPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::TieredPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::TieredPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::TieredPrice::Item] + # + # @param maximum [Orb::Models::Price::TieredPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::TieredPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::TieredPrice::PriceType] + # + # @param tiered_config [Orb::Models::Price::TieredPrice::TieredConfig] + # + # @param dimensional_price_configuration [Orb::Models::Price::TieredPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :tiered] # @see Orb::Models::Price::TieredPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -1619,12 +1493,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::TieredPrice#billing_cycle_configuration @@ -1640,13 +1510,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::TieredPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::TieredPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::TieredPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::TieredPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -1655,11 +1521,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1674,11 +1537,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::TieredPrice#credit_allocation @@ -1693,13 +1553,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::TieredPrice#invoicing_cycle_configuration @@ -1715,13 +1571,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -1730,11 +1582,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1750,13 +1599,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::TieredPrice#maximum @@ -1774,13 +1619,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::TieredPrice#minimum @@ -1798,13 +1644,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::TieredPrice#price_type @@ -1814,11 +1661,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::TieredPrice#tiered_config @@ -1829,12 +1673,8 @@ class TieredConfig < Orb::Internal::Type::BaseModel # @return [Array] required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Price::TieredPrice::TieredConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Tiers for rating based on total usage quantities into the specified tier class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit @@ -1855,14 +1695,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :last_unit, Float, nil?: true - # @!parse - # # @param first_unit [Float] - # # @param unit_amount [String] - # # @param last_unit [Float, nil] - # # - # def initialize(first_unit:, unit_amount:, last_unit: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(first_unit:, unit_amount:, last_unit: nil) + # @param first_unit [Float] Exclusive tier starting value + # + # @param unit_amount [String] Amount per unit + # + # @param last_unit [Float, nil] Inclusive tier ending value. If null, this is treated as the last tier end end @@ -1878,13 +1716,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -2018,63 +1852,58 @@ class TieredBpsPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::TieredBpsPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::TieredBpsPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::TieredBpsPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::TieredBpsPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::TieredBpsPrice::Item] - # # @param maximum [Orb::Models::Price::TieredBpsPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::TieredBpsPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::TieredBpsPrice::PriceType] - # # @param tiered_bps_config [Orb::Models::Price::TieredBpsPrice::TieredBpsConfig] - # # @param dimensional_price_configuration [Orb::Models::Price::TieredBpsPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :tiered_bps] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # tiered_bps_config:, - # dimensional_price_configuration: nil, - # model_type: :tiered_bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, tiered_bps_config:, dimensional_price_configuration: nil, model_type: :tiered_bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredBpsPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::TieredBpsPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::TieredBpsPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::TieredBpsPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::TieredBpsPrice::Item] + # + # @param maximum [Orb::Models::Price::TieredBpsPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::TieredBpsPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::TieredBpsPrice::PriceType] + # + # @param tiered_bps_config [Orb::Models::Price::TieredBpsPrice::TieredBpsConfig] + # + # @param dimensional_price_configuration [Orb::Models::Price::TieredBpsPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :tiered_bps] # @see Orb::Models::Price::TieredBpsPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -2083,12 +1912,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::TieredBpsPrice#billing_cycle_configuration @@ -2104,13 +1929,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -2119,11 +1940,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2138,11 +1956,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::TieredBpsPrice#credit_allocation @@ -2157,13 +1972,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::TieredBpsPrice#invoicing_cycle_configuration @@ -2179,13 +1990,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -2194,11 +2001,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2214,13 +2018,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::TieredBpsPrice#maximum @@ -2238,13 +2038,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredBpsPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::TieredBpsPrice#minimum @@ -2262,13 +2063,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredBpsPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::TieredBpsPrice#price_type @@ -2278,11 +2080,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::TieredBpsPrice#tiered_bps_config @@ -2295,12 +2094,12 @@ class TieredBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Price::TieredBpsPrice::TieredBpsConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredBpsPrice::TieredBpsConfig} for more details. + # + # @param tiers [Array] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -2327,15 +2126,14 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param minimum_amount [String] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Per-event basis point rate + # + # @param minimum_amount [String] Exclusive tier starting value + # + # @param maximum_amount [String, nil] Inclusive tier ending value + # + # @param per_unit_maximum [String, nil] Per unit maximum to charge end end @@ -2351,13 +2149,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -2490,63 +2284,58 @@ class BpsPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::BpsPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::BpsPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::BpsPrice::BillingCycleConfiguration] - # # @param bps_config [Orb::Models::Price::BpsPrice::BpsConfig] - # # @param cadence [Symbol, Orb::Models::Price::BpsPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::BpsPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::BpsPrice::Item] - # # @param maximum [Orb::Models::Price::BpsPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::BpsPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::BpsPrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::BpsPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :bps] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # bps_config:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, bps_config:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::BpsPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::BpsPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::BpsPrice::BillingCycleConfiguration] + # + # @param bps_config [Orb::Models::Price::BpsPrice::BpsConfig] + # + # @param cadence [Symbol, Orb::Models::Price::BpsPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::BpsPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::BpsPrice::Item] + # + # @param maximum [Orb::Models::Price::BpsPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::BpsPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::BpsPrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::BpsPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :bps] # @see Orb::Models::Price::BpsPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -2555,12 +2344,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::BpsPrice#billing_cycle_configuration @@ -2576,13 +2361,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::BpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::BpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::BpsPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::BpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -2591,11 +2372,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2613,13 +2391,10 @@ class BpsConfig < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, per_unit_maximum: nil) + # @param bps [Float] Basis point take rate per event + # + # @param per_unit_maximum [String, nil] Optional currency amount maximum to cap spend per event end # @see Orb::Models::Price::BpsPrice#cadence @@ -2633,11 +2408,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::BpsPrice#credit_allocation @@ -2652,13 +2424,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::BpsPrice#invoicing_cycle_configuration @@ -2674,13 +2442,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -2689,11 +2453,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2709,13 +2470,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::BpsPrice#maximum @@ -2733,13 +2490,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::BpsPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::BpsPrice#minimum @@ -2757,13 +2515,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::BpsPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::BpsPrice#price_type @@ -2773,11 +2532,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::BpsPrice#dimensional_price_configuration @@ -2792,13 +2548,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -2931,63 +2683,58 @@ class BulkBpsPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::BulkBpsPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::BulkBpsPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration] - # # @param bulk_bps_config [Orb::Models::Price::BulkBpsPrice::BulkBpsConfig] - # # @param cadence [Symbol, Orb::Models::Price::BulkBpsPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::BulkBpsPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::BulkBpsPrice::Item] - # # @param maximum [Orb::Models::Price::BulkBpsPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::BulkBpsPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::BulkBpsPrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::BulkBpsPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :bulk_bps] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # bulk_bps_config:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :bulk_bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, bulk_bps_config:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :bulk_bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::BulkBpsPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::BulkBpsPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration] + # + # @param bulk_bps_config [Orb::Models::Price::BulkBpsPrice::BulkBpsConfig] + # + # @param cadence [Symbol, Orb::Models::Price::BulkBpsPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::BulkBpsPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::BulkBpsPrice::Item] + # + # @param maximum [Orb::Models::Price::BulkBpsPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::BulkBpsPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::BulkBpsPrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::BulkBpsPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :bulk_bps] # @see Orb::Models::Price::BulkBpsPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -2996,12 +2743,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::BulkBpsPrice#billing_cycle_configuration @@ -3017,13 +2760,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -3032,11 +2771,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3050,12 +2786,12 @@ class BulkBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Price::BulkBpsPrice::BulkBpsConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::BulkBpsPrice::BulkBpsConfig} for more details. + # + # @param tiers [Array] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -3076,14 +2812,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Basis points to rate on + # + # @param maximum_amount [String, nil] Upper bound for tier + # + # @param per_unit_maximum [String, nil] The maximum amount to charge for any one event end end @@ -3098,11 +2832,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::BulkBpsPrice#credit_allocation @@ -3117,13 +2848,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::BulkBpsPrice#invoicing_cycle_configuration @@ -3139,13 +2866,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -3154,11 +2877,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3174,13 +2894,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::BulkBpsPrice#maximum @@ -3198,13 +2914,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::BulkBpsPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::BulkBpsPrice#minimum @@ -3222,13 +2939,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::BulkBpsPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::BulkBpsPrice#price_type @@ -3238,11 +2956,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::BulkBpsPrice#dimensional_price_configuration @@ -3257,13 +2972,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -3396,63 +3107,58 @@ class BulkPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::BulkPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::BulkPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::BulkPrice::BillingCycleConfiguration] - # # @param bulk_config [Orb::Models::Price::BulkPrice::BulkConfig] - # # @param cadence [Symbol, Orb::Models::Price::BulkPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::BulkPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::BulkPrice::Item] - # # @param maximum [Orb::Models::Price::BulkPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::BulkPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::BulkPrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::BulkPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :bulk] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # bulk_config:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :bulk, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, bulk_config:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :bulk) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::BulkPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::BulkPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::BulkPrice::BillingCycleConfiguration] + # + # @param bulk_config [Orb::Models::Price::BulkPrice::BulkConfig] + # + # @param cadence [Symbol, Orb::Models::Price::BulkPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::BulkPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::BulkPrice::Item] + # + # @param maximum [Orb::Models::Price::BulkPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::BulkPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::BulkPrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::BulkPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :bulk] # @see Orb::Models::Price::BulkPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -3461,12 +3167,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::BulkPrice#billing_cycle_configuration @@ -3482,13 +3184,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::BulkPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::BulkPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::BulkPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::BulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -3497,11 +3195,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3513,12 +3208,8 @@ class BulkConfig < Orb::Internal::Type::BaseModel # @return [Array] required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Price::BulkPrice::BulkConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Bulk tiers for rating based on total usage volume class Tier < Orb::Internal::Type::BaseModel # @!attribute unit_amount @@ -3533,13 +3224,10 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :maximum_units, Float, nil?: true - # @!parse - # # @param unit_amount [String] - # # @param maximum_units [Float, nil] - # # - # def initialize(unit_amount:, maximum_units: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:, maximum_units: nil) + # @param unit_amount [String] Amount per unit + # + # @param maximum_units [Float, nil] Upper bound for this tier end end @@ -3554,11 +3242,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::BulkPrice#credit_allocation @@ -3573,13 +3258,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::BulkPrice#invoicing_cycle_configuration @@ -3595,13 +3276,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -3610,11 +3287,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3630,13 +3304,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::BulkPrice#maximum @@ -3654,13 +3324,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::BulkPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::BulkPrice#minimum @@ -3678,13 +3349,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::BulkPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::BulkPrice#price_type @@ -3694,11 +3366,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::BulkPrice#dimensional_price_configuration @@ -3713,13 +3382,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -3857,63 +3522,58 @@ class ThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::ThresholdTotalAmountPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::ThresholdTotalAmountPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::ThresholdTotalAmountPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::ThresholdTotalAmountPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::ThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::ThresholdTotalAmountPrice::Item] - # # @param maximum [Orb::Models::Price::ThresholdTotalAmountPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::ThresholdTotalAmountPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::PriceType] - # # @param threshold_total_amount_config [Hash{Symbol=>Object}] - # # @param dimensional_price_configuration [Orb::Models::Price::ThresholdTotalAmountPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :threshold_total_amount] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # threshold_total_amount_config:, - # dimensional_price_configuration: nil, - # model_type: :threshold_total_amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, threshold_total_amount_config:, dimensional_price_configuration: nil, model_type: :threshold_total_amount) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::ThresholdTotalAmountPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::ThresholdTotalAmountPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::ThresholdTotalAmountPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::ThresholdTotalAmountPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::ThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::ThresholdTotalAmountPrice::Item] + # + # @param maximum [Orb::Models::Price::ThresholdTotalAmountPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::ThresholdTotalAmountPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::PriceType] + # + # @param threshold_total_amount_config [Hash{Symbol=>Object}] + # + # @param dimensional_price_configuration [Orb::Models::Price::ThresholdTotalAmountPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :threshold_total_amount] # @see Orb::Models::Price::ThresholdTotalAmountPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -3922,12 +3582,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::ThresholdTotalAmountPrice#billing_cycle_configuration @@ -3943,13 +3599,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::ThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::ThresholdTotalAmountPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -3958,11 +3610,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3977,11 +3626,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::ThresholdTotalAmountPrice#credit_allocation @@ -3996,13 +3642,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::ThresholdTotalAmountPrice#invoicing_cycle_configuration @@ -4018,13 +3660,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::ThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::ThresholdTotalAmountPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -4033,11 +3671,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4053,13 +3688,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::ThresholdTotalAmountPrice#maximum @@ -4077,13 +3708,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::ThresholdTotalAmountPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::ThresholdTotalAmountPrice#minimum @@ -4101,13 +3733,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::ThresholdTotalAmountPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::ThresholdTotalAmountPrice#price_type @@ -4117,11 +3750,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::ThresholdTotalAmountPrice#dimensional_price_configuration @@ -4136,13 +3766,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -4271,68 +3897,63 @@ class TieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute dimensional_price_configuration # - # @return [Orb::Models::Price::TieredPackagePrice::DimensionalPriceConfiguration, nil] - optional :dimensional_price_configuration, - -> { Orb::Models::Price::TieredPackagePrice::DimensionalPriceConfiguration }, - nil?: true - - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::TieredPackagePrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::TieredPackagePrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::TieredPackagePrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::TieredPackagePrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::TieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::TieredPackagePrice::Item] - # # @param maximum [Orb::Models::Price::TieredPackagePrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::TieredPackagePrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::TieredPackagePrice::PriceType] - # # @param tiered_package_config [Hash{Symbol=>Object}] - # # @param dimensional_price_configuration [Orb::Models::Price::TieredPackagePrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :tiered_package] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # tiered_package_config:, - # dimensional_price_configuration: nil, - # model_type: :tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @return [Orb::Models::Price::TieredPackagePrice::DimensionalPriceConfiguration, nil] + optional :dimensional_price_configuration, + -> { Orb::Models::Price::TieredPackagePrice::DimensionalPriceConfiguration }, + nil?: true + + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, tiered_package_config:, dimensional_price_configuration: nil, model_type: :tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredPackagePrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::TieredPackagePrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::TieredPackagePrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::TieredPackagePrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::TieredPackagePrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::TieredPackagePrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::TieredPackagePrice::Item] + # + # @param maximum [Orb::Models::Price::TieredPackagePrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::TieredPackagePrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::TieredPackagePrice::PriceType] + # + # @param tiered_package_config [Hash{Symbol=>Object}] + # + # @param dimensional_price_configuration [Orb::Models::Price::TieredPackagePrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :tiered_package] # @see Orb::Models::Price::TieredPackagePrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -4341,12 +3962,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::TieredPackagePrice#billing_cycle_configuration @@ -4362,13 +3979,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::TieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::TieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::TieredPackagePrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::TieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -4377,11 +3990,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4396,11 +4006,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::TieredPackagePrice#credit_allocation @@ -4415,13 +4022,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::TieredPackagePrice#invoicing_cycle_configuration @@ -4437,13 +4040,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::TieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::TieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::TieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::TieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -4452,11 +4051,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4472,13 +4068,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::TieredPackagePrice#maximum @@ -4496,13 +4088,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredPackagePrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::TieredPackagePrice#minimum @@ -4520,13 +4113,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredPackagePrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::TieredPackagePrice#price_type @@ -4536,11 +4130,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::TieredPackagePrice#dimensional_price_configuration @@ -4555,13 +4146,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -4695,63 +4282,58 @@ class GroupedTieredPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::GroupedTieredPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::GroupedTieredPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::GroupedTieredPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::GroupedTieredPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::GroupedTieredPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param grouped_tiered_config [Hash{Symbol=>Object}] - # # @param invoicing_cycle_configuration [Orb::Models::Price::GroupedTieredPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::GroupedTieredPrice::Item] - # # @param maximum [Orb::Models::Price::GroupedTieredPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::GroupedTieredPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::GroupedTieredPrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::GroupedTieredPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :grouped_tiered] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # grouped_tiered_config:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :grouped_tiered, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_tiered_config:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :grouped_tiered) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedTieredPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::GroupedTieredPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::GroupedTieredPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::GroupedTieredPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::GroupedTieredPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param grouped_tiered_config [Hash{Symbol=>Object}] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::GroupedTieredPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::GroupedTieredPrice::Item] + # + # @param maximum [Orb::Models::Price::GroupedTieredPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::GroupedTieredPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::GroupedTieredPrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::GroupedTieredPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :grouped_tiered] # @see Orb::Models::Price::GroupedTieredPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -4760,12 +4342,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::GroupedTieredPrice#billing_cycle_configuration @@ -4781,13 +4359,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::GroupedTieredPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::GroupedTieredPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::GroupedTieredPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::GroupedTieredPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -4796,11 +4370,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4815,11 +4386,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::GroupedTieredPrice#credit_allocation @@ -4834,13 +4402,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::GroupedTieredPrice#invoicing_cycle_configuration @@ -4856,13 +4420,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::GroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::GroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::GroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::GroupedTieredPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -4871,11 +4431,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4891,13 +4448,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::GroupedTieredPrice#maximum @@ -4915,13 +4468,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedTieredPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::GroupedTieredPrice#minimum @@ -4939,13 +4493,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedTieredPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::GroupedTieredPrice#price_type @@ -4955,11 +4510,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::GroupedTieredPrice#dimensional_price_configuration @@ -4974,13 +4526,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -5116,63 +4664,58 @@ class TieredWithMinimumPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::TieredWithMinimumPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::TieredWithMinimumPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::TieredWithMinimumPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::TieredWithMinimumPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::TieredWithMinimumPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::TieredWithMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::TieredWithMinimumPrice::Item] - # # @param maximum [Orb::Models::Price::TieredWithMinimumPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::TieredWithMinimumPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::TieredWithMinimumPrice::PriceType] - # # @param tiered_with_minimum_config [Hash{Symbol=>Object}] - # # @param dimensional_price_configuration [Orb::Models::Price::TieredWithMinimumPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :tiered_with_minimum] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # tiered_with_minimum_config:, - # dimensional_price_configuration: nil, - # model_type: :tiered_with_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, tiered_with_minimum_config:, dimensional_price_configuration: nil, model_type: :tiered_with_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredWithMinimumPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::TieredWithMinimumPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::TieredWithMinimumPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::TieredWithMinimumPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::TieredWithMinimumPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::TieredWithMinimumPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::TieredWithMinimumPrice::Item] + # + # @param maximum [Orb::Models::Price::TieredWithMinimumPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::TieredWithMinimumPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::TieredWithMinimumPrice::PriceType] + # + # @param tiered_with_minimum_config [Hash{Symbol=>Object}] + # + # @param dimensional_price_configuration [Orb::Models::Price::TieredWithMinimumPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :tiered_with_minimum] # @see Orb::Models::Price::TieredWithMinimumPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -5181,12 +4724,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::TieredWithMinimumPrice#billing_cycle_configuration @@ -5202,13 +4741,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::TieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::TieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::TieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::TieredWithMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -5217,11 +4752,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5236,11 +4768,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::TieredWithMinimumPrice#credit_allocation @@ -5255,13 +4784,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::TieredWithMinimumPrice#invoicing_cycle_configuration @@ -5277,13 +4802,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::TieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::TieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::TieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::TieredWithMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -5292,11 +4813,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5312,13 +4830,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::TieredWithMinimumPrice#maximum @@ -5336,13 +4850,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredWithMinimumPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::TieredWithMinimumPrice#minimum @@ -5360,13 +4875,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredWithMinimumPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::TieredWithMinimumPrice#price_type @@ -5376,11 +4892,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::TieredWithMinimumPrice#dimensional_price_configuration @@ -5395,13 +4908,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -5540,63 +5049,58 @@ class TieredPackageWithMinimumPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::TieredPackageWithMinimumPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::TieredPackageWithMinimumPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::TieredPackageWithMinimumPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::TieredPackageWithMinimumPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::TieredPackageWithMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::TieredPackageWithMinimumPrice::Item] - # # @param maximum [Orb::Models::Price::TieredPackageWithMinimumPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::TieredPackageWithMinimumPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::PriceType] - # # @param tiered_package_with_minimum_config [Hash{Symbol=>Object}] - # # @param dimensional_price_configuration [Orb::Models::Price::TieredPackageWithMinimumPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :tiered_package_with_minimum] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # tiered_package_with_minimum_config:, - # dimensional_price_configuration: nil, - # model_type: :tiered_package_with_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, tiered_package_with_minimum_config:, dimensional_price_configuration: nil, model_type: :tiered_package_with_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredPackageWithMinimumPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::TieredPackageWithMinimumPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::TieredPackageWithMinimumPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::TieredPackageWithMinimumPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::TieredPackageWithMinimumPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::TieredPackageWithMinimumPrice::Item] + # + # @param maximum [Orb::Models::Price::TieredPackageWithMinimumPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::TieredPackageWithMinimumPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::PriceType] + # + # @param tiered_package_with_minimum_config [Hash{Symbol=>Object}] + # + # @param dimensional_price_configuration [Orb::Models::Price::TieredPackageWithMinimumPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :tiered_package_with_minimum] # @see Orb::Models::Price::TieredPackageWithMinimumPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -5605,12 +5109,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::TieredPackageWithMinimumPrice#billing_cycle_configuration @@ -5626,13 +5126,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::TieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::TieredPackageWithMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -5641,11 +5137,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5660,11 +5153,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::TieredPackageWithMinimumPrice#credit_allocation @@ -5679,13 +5169,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::TieredPackageWithMinimumPrice#invoicing_cycle_configuration @@ -5701,13 +5187,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::TieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::TieredPackageWithMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -5716,11 +5198,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5736,13 +5215,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::TieredPackageWithMinimumPrice#maximum @@ -5760,13 +5235,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredPackageWithMinimumPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::TieredPackageWithMinimumPrice#minimum @@ -5784,13 +5260,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredPackageWithMinimumPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::TieredPackageWithMinimumPrice#price_type @@ -5800,11 +5277,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::TieredPackageWithMinimumPrice#dimensional_price_configuration @@ -5819,13 +5293,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -5963,63 +5433,58 @@ class PackageWithAllocationPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::PackageWithAllocationPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::PackageWithAllocationPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::PackageWithAllocationPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::PackageWithAllocationPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::PackageWithAllocationPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::PackageWithAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::PackageWithAllocationPrice::Item] - # # @param maximum [Orb::Models::Price::PackageWithAllocationPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::PackageWithAllocationPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param package_with_allocation_config [Hash{Symbol=>Object}] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::PackageWithAllocationPrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::PackageWithAllocationPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :package_with_allocation] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # package_with_allocation_config:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :package_with_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, package_with_allocation_config:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :package_with_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::PackageWithAllocationPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::PackageWithAllocationPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::PackageWithAllocationPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::PackageWithAllocationPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::PackageWithAllocationPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::PackageWithAllocationPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::PackageWithAllocationPrice::Item] + # + # @param maximum [Orb::Models::Price::PackageWithAllocationPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::PackageWithAllocationPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param package_with_allocation_config [Hash{Symbol=>Object}] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::PackageWithAllocationPrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::PackageWithAllocationPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :package_with_allocation] # @see Orb::Models::Price::PackageWithAllocationPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -6028,12 +5493,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::PackageWithAllocationPrice#billing_cycle_configuration @@ -6049,13 +5510,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::PackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::PackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::PackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::PackageWithAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -6064,11 +5521,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6083,11 +5537,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::PackageWithAllocationPrice#credit_allocation @@ -6102,13 +5553,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::PackageWithAllocationPrice#invoicing_cycle_configuration @@ -6124,13 +5571,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::PackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::PackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::PackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::PackageWithAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -6139,11 +5582,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6159,13 +5599,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::PackageWithAllocationPrice#maximum @@ -6183,13 +5619,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::PackageWithAllocationPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::PackageWithAllocationPrice#minimum @@ -6207,13 +5644,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::PackageWithAllocationPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::PackageWithAllocationPrice#price_type @@ -6223,11 +5661,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::PackageWithAllocationPrice#dimensional_price_configuration @@ -6242,13 +5677,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -6382,63 +5813,58 @@ class UnitWithPercentPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::UnitWithPercentPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::UnitWithPercentPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::UnitWithPercentPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::UnitWithPercentPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::UnitWithPercentPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::UnitWithPercentPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::UnitWithPercentPrice::Item] - # # @param maximum [Orb::Models::Price::UnitWithPercentPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::UnitWithPercentPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::UnitWithPercentPrice::PriceType] - # # @param unit_with_percent_config [Hash{Symbol=>Object}] - # # @param dimensional_price_configuration [Orb::Models::Price::UnitWithPercentPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :unit_with_percent] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # unit_with_percent_config:, - # dimensional_price_configuration: nil, - # model_type: :unit_with_percent, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, unit_with_percent_config:, dimensional_price_configuration: nil, model_type: :unit_with_percent) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::UnitWithPercentPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::UnitWithPercentPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::UnitWithPercentPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::UnitWithPercentPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::UnitWithPercentPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::UnitWithPercentPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::UnitWithPercentPrice::Item] + # + # @param maximum [Orb::Models::Price::UnitWithPercentPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::UnitWithPercentPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::UnitWithPercentPrice::PriceType] + # + # @param unit_with_percent_config [Hash{Symbol=>Object}] + # + # @param dimensional_price_configuration [Orb::Models::Price::UnitWithPercentPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :unit_with_percent] # @see Orb::Models::Price::UnitWithPercentPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -6447,12 +5873,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::UnitWithPercentPrice#billing_cycle_configuration @@ -6468,13 +5890,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::UnitWithPercentPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::UnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::UnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::UnitWithPercentPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -6483,11 +5901,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6502,11 +5917,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::UnitWithPercentPrice#credit_allocation @@ -6521,13 +5933,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::UnitWithPercentPrice#invoicing_cycle_configuration @@ -6543,13 +5951,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::UnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::UnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::UnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::UnitWithPercentPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -6558,11 +5962,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6578,13 +5979,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::UnitWithPercentPrice#maximum @@ -6602,13 +5999,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::UnitWithPercentPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::UnitWithPercentPrice#minimum @@ -6626,13 +6024,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::UnitWithPercentPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::UnitWithPercentPrice#price_type @@ -6642,11 +6041,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::UnitWithPercentPrice#dimensional_price_configuration @@ -6661,13 +6057,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -6796,73 +6188,68 @@ class MatrixWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute price_type # - # @return [Symbol, Orb::Models::Price::MatrixWithAllocationPrice::PriceType] - required :price_type, enum: -> { Orb::Models::Price::MatrixWithAllocationPrice::PriceType } - - # @!attribute dimensional_price_configuration + # @return [Symbol, Orb::Models::Price::MatrixWithAllocationPrice::PriceType] + required :price_type, enum: -> { Orb::Models::Price::MatrixWithAllocationPrice::PriceType } + + # @!attribute dimensional_price_configuration + # + # @return [Orb::Models::Price::MatrixWithAllocationPrice::DimensionalPriceConfiguration, nil] + optional :dimensional_price_configuration, + -> { Orb::Models::Price::MatrixWithAllocationPrice::DimensionalPriceConfiguration }, + nil?: true + + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, matrix_with_allocation_config:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :matrix_with_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::MatrixWithAllocationPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::MatrixWithAllocationPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::MatrixWithAllocationPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::MatrixWithAllocationPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::MatrixWithAllocationPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::MatrixWithAllocationPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::MatrixWithAllocationPrice::Item] + # + # @param matrix_with_allocation_config [Orb::Models::Price::MatrixWithAllocationPrice::MatrixWithAllocationConfig] + # + # @param maximum [Orb::Models::Price::MatrixWithAllocationPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::MatrixWithAllocationPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::MatrixWithAllocationPrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::MatrixWithAllocationPrice::DimensionalPriceConfiguration, nil] # - # @return [Orb::Models::Price::MatrixWithAllocationPrice::DimensionalPriceConfiguration, nil] - optional :dimensional_price_configuration, - -> { Orb::Models::Price::MatrixWithAllocationPrice::DimensionalPriceConfiguration }, - nil?: true - - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::MatrixWithAllocationPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::MatrixWithAllocationPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::MatrixWithAllocationPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::MatrixWithAllocationPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::MatrixWithAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::MatrixWithAllocationPrice::Item] - # # @param matrix_with_allocation_config [Orb::Models::Price::MatrixWithAllocationPrice::MatrixWithAllocationConfig] - # # @param maximum [Orb::Models::Price::MatrixWithAllocationPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::MatrixWithAllocationPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::MatrixWithAllocationPrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::MatrixWithAllocationPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :matrix_with_allocation] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # matrix_with_allocation_config:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :matrix_with_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @param model_type [Symbol, :matrix_with_allocation] # @see Orb::Models::Price::MatrixWithAllocationPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -6871,12 +6258,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::MatrixWithAllocationPrice#billing_cycle_configuration @@ -6892,13 +6275,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::MatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::MatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::MatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::MatrixWithAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -6907,11 +6286,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6926,11 +6302,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::MatrixWithAllocationPrice#credit_allocation @@ -6945,13 +6318,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::MatrixWithAllocationPrice#invoicing_cycle_configuration @@ -6967,13 +6336,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::MatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::MatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::MatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::MatrixWithAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -6982,11 +6347,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7002,13 +6364,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::MatrixWithAllocationPrice#matrix_with_allocation_config @@ -7038,15 +6396,14 @@ class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel required :matrix_values, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Price::MatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue] } - # @!parse - # # @param allocation [Float] - # # @param default_unit_amount [String] - # # @param dimensions [Array] - # # @param matrix_values [Array] - # # - # def initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:) + # @param allocation [Float] Allocation to be used to calculate the price + # + # @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value + # + # @param dimensions [Array] One or two event property values to evaluate matrix groups by + # + # @param matrix_values [Array] Matrix values for specified matrix grouping keys class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values @@ -7063,13 +6420,15 @@ class MatrixValue < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param dimension_values [Array] - # # @param unit_amount [String] - # # - # def initialize(dimension_values:, unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, unit_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::MatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue} + # for more details. + # + # @param dimension_values [Array] One or two matrix keys to filter usage to this Matrix value by. For example, ["r + # ... + # + # @param unit_amount [String] Unit price for the specified dimension_values end end @@ -7088,13 +6447,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::MatrixWithAllocationPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::MatrixWithAllocationPrice#minimum @@ -7112,13 +6472,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::MatrixWithAllocationPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::MatrixWithAllocationPrice#price_type @@ -7128,11 +6489,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::MatrixWithAllocationPrice#dimensional_price_configuration @@ -7147,13 +6505,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -7289,63 +6643,58 @@ class TieredWithProrationPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::TieredWithProrationPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::TieredWithProrationPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::TieredWithProrationPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::TieredWithProrationPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::TieredWithProrationPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::TieredWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::TieredWithProrationPrice::Item] - # # @param maximum [Orb::Models::Price::TieredWithProrationPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::TieredWithProrationPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::TieredWithProrationPrice::PriceType] - # # @param tiered_with_proration_config [Hash{Symbol=>Object}] - # # @param dimensional_price_configuration [Orb::Models::Price::TieredWithProrationPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :tiered_with_proration] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # tiered_with_proration_config:, - # dimensional_price_configuration: nil, - # model_type: :tiered_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, tiered_with_proration_config:, dimensional_price_configuration: nil, model_type: :tiered_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredWithProrationPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::TieredWithProrationPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::TieredWithProrationPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::TieredWithProrationPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::TieredWithProrationPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::TieredWithProrationPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::TieredWithProrationPrice::Item] + # + # @param maximum [Orb::Models::Price::TieredWithProrationPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::TieredWithProrationPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::TieredWithProrationPrice::PriceType] + # + # @param tiered_with_proration_config [Hash{Symbol=>Object}] + # + # @param dimensional_price_configuration [Orb::Models::Price::TieredWithProrationPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :tiered_with_proration] # @see Orb::Models::Price::TieredWithProrationPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -7354,12 +6703,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::TieredWithProrationPrice#billing_cycle_configuration @@ -7375,13 +6720,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::TieredWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::TieredWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::TieredWithProrationPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::TieredWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -7390,11 +6731,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7409,11 +6747,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::TieredWithProrationPrice#credit_allocation @@ -7428,13 +6763,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::TieredWithProrationPrice#invoicing_cycle_configuration @@ -7450,13 +6781,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::TieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::TieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::TieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::TieredWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -7465,11 +6792,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7485,13 +6809,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::TieredWithProrationPrice#maximum @@ -7509,13 +6829,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredWithProrationPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::TieredWithProrationPrice#minimum @@ -7533,13 +6854,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::TieredWithProrationPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::TieredWithProrationPrice#price_type @@ -7549,11 +6871,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::TieredWithProrationPrice#dimensional_price_configuration @@ -7568,13 +6887,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -7710,63 +7025,58 @@ class UnitWithProrationPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::UnitWithProrationPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::UnitWithProrationPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::UnitWithProrationPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::UnitWithProrationPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::UnitWithProrationPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::UnitWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::UnitWithProrationPrice::Item] - # # @param maximum [Orb::Models::Price::UnitWithProrationPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::UnitWithProrationPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::UnitWithProrationPrice::PriceType] - # # @param unit_with_proration_config [Hash{Symbol=>Object}] - # # @param dimensional_price_configuration [Orb::Models::Price::UnitWithProrationPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :unit_with_proration] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # unit_with_proration_config:, - # dimensional_price_configuration: nil, - # model_type: :unit_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, unit_with_proration_config:, dimensional_price_configuration: nil, model_type: :unit_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::UnitWithProrationPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::UnitWithProrationPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::UnitWithProrationPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::UnitWithProrationPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::UnitWithProrationPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::UnitWithProrationPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::UnitWithProrationPrice::Item] + # + # @param maximum [Orb::Models::Price::UnitWithProrationPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::UnitWithProrationPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::UnitWithProrationPrice::PriceType] + # + # @param unit_with_proration_config [Hash{Symbol=>Object}] + # + # @param dimensional_price_configuration [Orb::Models::Price::UnitWithProrationPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :unit_with_proration] # @see Orb::Models::Price::UnitWithProrationPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -7775,12 +7085,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::UnitWithProrationPrice#billing_cycle_configuration @@ -7796,13 +7102,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::UnitWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::UnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::UnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::UnitWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -7811,11 +7113,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7830,11 +7129,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::UnitWithProrationPrice#credit_allocation @@ -7849,13 +7145,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::UnitWithProrationPrice#invoicing_cycle_configuration @@ -7871,13 +7163,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::UnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::UnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::UnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::UnitWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -7886,11 +7174,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7906,13 +7191,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::UnitWithProrationPrice#maximum @@ -7930,13 +7211,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::UnitWithProrationPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::UnitWithProrationPrice#minimum @@ -7954,13 +7236,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::UnitWithProrationPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::UnitWithProrationPrice#price_type @@ -7970,11 +7253,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::UnitWithProrationPrice#dimensional_price_configuration @@ -7989,13 +7269,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -8131,63 +7407,58 @@ class GroupedAllocationPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::GroupedAllocationPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::GroupedAllocationPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::GroupedAllocationPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::GroupedAllocationPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::GroupedAllocationPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param grouped_allocation_config [Hash{Symbol=>Object}] - # # @param invoicing_cycle_configuration [Orb::Models::Price::GroupedAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::GroupedAllocationPrice::Item] - # # @param maximum [Orb::Models::Price::GroupedAllocationPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::GroupedAllocationPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::GroupedAllocationPrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::GroupedAllocationPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :grouped_allocation] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # grouped_allocation_config:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :grouped_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_allocation_config:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :grouped_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedAllocationPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::GroupedAllocationPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::GroupedAllocationPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::GroupedAllocationPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::GroupedAllocationPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param grouped_allocation_config [Hash{Symbol=>Object}] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::GroupedAllocationPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::GroupedAllocationPrice::Item] + # + # @param maximum [Orb::Models::Price::GroupedAllocationPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::GroupedAllocationPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::GroupedAllocationPrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::GroupedAllocationPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :grouped_allocation] # @see Orb::Models::Price::GroupedAllocationPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -8196,12 +7467,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::GroupedAllocationPrice#billing_cycle_configuration @@ -8217,13 +7484,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::GroupedAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::GroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::GroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::GroupedAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -8232,11 +7495,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -8251,11 +7511,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::GroupedAllocationPrice#credit_allocation @@ -8270,13 +7527,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::GroupedAllocationPrice#invoicing_cycle_configuration @@ -8292,13 +7545,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::GroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::GroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::GroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::GroupedAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -8307,11 +7556,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -8327,13 +7573,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::GroupedAllocationPrice#maximum @@ -8351,13 +7593,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedAllocationPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::GroupedAllocationPrice#minimum @@ -8375,13 +7618,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedAllocationPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::GroupedAllocationPrice#price_type @@ -8391,11 +7635,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::GroupedAllocationPrice#dimensional_price_configuration @@ -8410,13 +7651,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -8555,63 +7792,58 @@ class GroupedWithProratedMinimumPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::GroupedWithProratedMinimumPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::GroupedWithProratedMinimumPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::GroupedWithProratedMinimumPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::GroupedWithProratedMinimumPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] - # # @param invoicing_cycle_configuration [Orb::Models::Price::GroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::GroupedWithProratedMinimumPrice::Item] - # # @param maximum [Orb::Models::Price::GroupedWithProratedMinimumPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::GroupedWithProratedMinimumPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::GroupedWithProratedMinimumPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :grouped_with_prorated_minimum] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # grouped_with_prorated_minimum_config:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :grouped_with_prorated_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_with_prorated_minimum_config:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :grouped_with_prorated_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedWithProratedMinimumPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::GroupedWithProratedMinimumPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::GroupedWithProratedMinimumPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::GroupedWithProratedMinimumPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::GroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::GroupedWithProratedMinimumPrice::Item] + # + # @param maximum [Orb::Models::Price::GroupedWithProratedMinimumPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::GroupedWithProratedMinimumPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::GroupedWithProratedMinimumPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :grouped_with_prorated_minimum] # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -8620,12 +7852,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#billing_cycle_configuration @@ -8641,13 +7869,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::GroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::GroupedWithProratedMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -8656,11 +7880,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -8675,11 +7896,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#credit_allocation @@ -8694,13 +7912,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#invoicing_cycle_configuration @@ -8716,13 +7930,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::GroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::GroupedWithProratedMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -8731,11 +7941,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -8751,13 +7958,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#maximum @@ -8775,13 +7978,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedWithProratedMinimumPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#minimum @@ -8799,13 +8003,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedWithProratedMinimumPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#price_type @@ -8815,11 +8020,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#dimensional_price_configuration @@ -8834,13 +8036,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -8979,63 +8177,58 @@ class GroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::GroupedWithMeteredMinimumPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::GroupedWithMeteredMinimumPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] - # # @param invoicing_cycle_configuration [Orb::Models::Price::GroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::GroupedWithMeteredMinimumPrice::Item] - # # @param maximum [Orb::Models::Price::GroupedWithMeteredMinimumPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::GroupedWithMeteredMinimumPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::GroupedWithMeteredMinimumPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :grouped_with_metered_minimum] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # grouped_with_metered_minimum_config:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :grouped_with_metered_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_with_metered_minimum_config:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :grouped_with_metered_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedWithMeteredMinimumPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::GroupedWithMeteredMinimumPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::GroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::GroupedWithMeteredMinimumPrice::Item] + # + # @param maximum [Orb::Models::Price::GroupedWithMeteredMinimumPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::GroupedWithMeteredMinimumPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::GroupedWithMeteredMinimumPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :grouped_with_metered_minimum] # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -9044,12 +8237,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#billing_cycle_configuration @@ -9065,13 +8254,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -9080,11 +8265,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -9099,11 +8281,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#credit_allocation @@ -9118,13 +8297,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#invoicing_cycle_configuration @@ -9140,13 +8315,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::GroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -9155,11 +8326,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -9175,13 +8343,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#maximum @@ -9199,13 +8363,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedWithMeteredMinimumPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#minimum @@ -9223,13 +8388,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedWithMeteredMinimumPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#price_type @@ -9239,11 +8405,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#dimensional_price_configuration @@ -9258,13 +8421,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -9402,63 +8561,58 @@ class MatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::MatrixWithDisplayNamePrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::MatrixWithDisplayNamePrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::MatrixWithDisplayNamePrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::MatrixWithDisplayNamePrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::MatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::MatrixWithDisplayNamePrice::Item] - # # @param matrix_with_display_name_config [Hash{Symbol=>Object}] - # # @param maximum [Orb::Models::Price::MatrixWithDisplayNamePrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::MatrixWithDisplayNamePrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::MatrixWithDisplayNamePrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :matrix_with_display_name] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # matrix_with_display_name_config:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :matrix_with_display_name, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, matrix_with_display_name_config:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :matrix_with_display_name) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::MatrixWithDisplayNamePrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::MatrixWithDisplayNamePrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::MatrixWithDisplayNamePrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::MatrixWithDisplayNamePrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::MatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::MatrixWithDisplayNamePrice::Item] + # + # @param matrix_with_display_name_config [Hash{Symbol=>Object}] + # + # @param maximum [Orb::Models::Price::MatrixWithDisplayNamePrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::MatrixWithDisplayNamePrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::MatrixWithDisplayNamePrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :matrix_with_display_name] # @see Orb::Models::Price::MatrixWithDisplayNamePrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -9467,12 +8621,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::MatrixWithDisplayNamePrice#billing_cycle_configuration @@ -9488,13 +8638,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::MatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::MatrixWithDisplayNamePrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -9503,11 +8649,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -9522,11 +8665,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::MatrixWithDisplayNamePrice#credit_allocation @@ -9541,13 +8681,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::MatrixWithDisplayNamePrice#invoicing_cycle_configuration @@ -9563,13 +8699,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::MatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::MatrixWithDisplayNamePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -9578,11 +8710,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -9598,13 +8727,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::MatrixWithDisplayNamePrice#maximum @@ -9622,13 +8747,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::MatrixWithDisplayNamePrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::MatrixWithDisplayNamePrice#minimum @@ -9646,13 +8772,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::MatrixWithDisplayNamePrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::MatrixWithDisplayNamePrice#price_type @@ -9662,11 +8789,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::MatrixWithDisplayNamePrice#dimensional_price_configuration @@ -9681,13 +8805,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -9823,63 +8943,58 @@ class BulkWithProrationPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::BulkWithProrationPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::BulkWithProrationPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::BulkWithProrationPrice::BillingCycleConfiguration] - # # @param bulk_with_proration_config [Hash{Symbol=>Object}] - # # @param cadence [Symbol, Orb::Models::Price::BulkWithProrationPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::BulkWithProrationPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::BulkWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::BulkWithProrationPrice::Item] - # # @param maximum [Orb::Models::Price::BulkWithProrationPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::BulkWithProrationPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::BulkWithProrationPrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::BulkWithProrationPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :bulk_with_proration] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # bulk_with_proration_config:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :bulk_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, bulk_with_proration_config:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :bulk_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::BulkWithProrationPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::BulkWithProrationPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::BulkWithProrationPrice::BillingCycleConfiguration] + # + # @param bulk_with_proration_config [Hash{Symbol=>Object}] + # + # @param cadence [Symbol, Orb::Models::Price::BulkWithProrationPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::BulkWithProrationPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::BulkWithProrationPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::BulkWithProrationPrice::Item] + # + # @param maximum [Orb::Models::Price::BulkWithProrationPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::BulkWithProrationPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::BulkWithProrationPrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::BulkWithProrationPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :bulk_with_proration] # @see Orb::Models::Price::BulkWithProrationPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -9888,12 +9003,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::BulkWithProrationPrice#billing_cycle_configuration @@ -9909,13 +9020,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::BulkWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::BulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::BulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::BulkWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -9924,11 +9031,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -9943,11 +9047,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::BulkWithProrationPrice#credit_allocation @@ -9962,13 +9063,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::BulkWithProrationPrice#invoicing_cycle_configuration @@ -9984,13 +9081,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::BulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::BulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::BulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::BulkWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -9999,11 +9092,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -10019,13 +9109,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::BulkWithProrationPrice#maximum @@ -10043,13 +9129,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::BulkWithProrationPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::BulkWithProrationPrice#minimum @@ -10067,13 +9154,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::BulkWithProrationPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::BulkWithProrationPrice#price_type @@ -10083,11 +9171,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::BulkWithProrationPrice#dimensional_price_configuration @@ -10102,13 +9187,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -10246,63 +9327,58 @@ class GroupedTieredPackagePrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::GroupedTieredPackagePrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::GroupedTieredPackagePrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::GroupedTieredPackagePrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::GroupedTieredPackagePrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::GroupedTieredPackagePrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param grouped_tiered_package_config [Hash{Symbol=>Object}] - # # @param invoicing_cycle_configuration [Orb::Models::Price::GroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::GroupedTieredPackagePrice::Item] - # # @param maximum [Orb::Models::Price::GroupedTieredPackagePrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::GroupedTieredPackagePrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::GroupedTieredPackagePrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::GroupedTieredPackagePrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :grouped_tiered_package] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # grouped_tiered_package_config:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :grouped_tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_tiered_package_config:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :grouped_tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedTieredPackagePrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::GroupedTieredPackagePrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::GroupedTieredPackagePrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::GroupedTieredPackagePrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::GroupedTieredPackagePrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param grouped_tiered_package_config [Hash{Symbol=>Object}] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::GroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::GroupedTieredPackagePrice::Item] + # + # @param maximum [Orb::Models::Price::GroupedTieredPackagePrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::GroupedTieredPackagePrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::GroupedTieredPackagePrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::GroupedTieredPackagePrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :grouped_tiered_package] # @see Orb::Models::Price::GroupedTieredPackagePrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -10311,12 +9387,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::GroupedTieredPackagePrice#billing_cycle_configuration @@ -10332,13 +9404,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::GroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::GroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::GroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::GroupedTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -10347,11 +9415,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -10366,11 +9431,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::GroupedTieredPackagePrice#credit_allocation @@ -10385,13 +9447,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::GroupedTieredPackagePrice#invoicing_cycle_configuration @@ -10407,13 +9465,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::GroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::GroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::GroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::GroupedTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -10422,11 +9476,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -10442,13 +9493,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::GroupedTieredPackagePrice#maximum @@ -10466,13 +9513,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedTieredPackagePrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::GroupedTieredPackagePrice#minimum @@ -10490,13 +9538,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::GroupedTieredPackagePrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::GroupedTieredPackagePrice#price_type @@ -10506,11 +9555,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::GroupedTieredPackagePrice#dimensional_price_configuration @@ -10525,13 +9571,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -10669,63 +9711,58 @@ class MaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::MaxGroupTieredPackagePrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::MaxGroupTieredPackagePrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::MaxGroupTieredPackagePrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::MaxGroupTieredPackagePrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::MaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::MaxGroupTieredPackagePrice::Item] - # # @param max_group_tiered_package_config [Hash{Symbol=>Object}] - # # @param maximum [Orb::Models::Price::MaxGroupTieredPackagePrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::MaxGroupTieredPackagePrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::MaxGroupTieredPackagePrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :max_group_tiered_package] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # max_group_tiered_package_config:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :max_group_tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, max_group_tiered_package_config:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :max_group_tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::MaxGroupTieredPackagePrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::MaxGroupTieredPackagePrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::MaxGroupTieredPackagePrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::MaxGroupTieredPackagePrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::MaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::MaxGroupTieredPackagePrice::Item] + # + # @param max_group_tiered_package_config [Hash{Symbol=>Object}] + # + # @param maximum [Orb::Models::Price::MaxGroupTieredPackagePrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::MaxGroupTieredPackagePrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::MaxGroupTieredPackagePrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :max_group_tiered_package] # @see Orb::Models::Price::MaxGroupTieredPackagePrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -10734,12 +9771,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::MaxGroupTieredPackagePrice#billing_cycle_configuration @@ -10755,13 +9788,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::MaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::MaxGroupTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -10770,11 +9799,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -10789,11 +9815,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::MaxGroupTieredPackagePrice#credit_allocation @@ -10808,13 +9831,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::MaxGroupTieredPackagePrice#invoicing_cycle_configuration @@ -10830,13 +9849,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::MaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::MaxGroupTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -10845,11 +9860,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -10865,13 +9877,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::MaxGroupTieredPackagePrice#maximum @@ -10889,13 +9897,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::MaxGroupTieredPackagePrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::MaxGroupTieredPackagePrice#minimum @@ -10913,13 +9922,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::MaxGroupTieredPackagePrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::MaxGroupTieredPackagePrice#price_type @@ -10929,11 +9939,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::MaxGroupTieredPackagePrice#dimensional_price_configuration @@ -10948,13 +9955,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -11093,63 +10096,58 @@ class ScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Item] - # # @param maximum [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::PriceType] - # # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] - # # @param dimensional_price_configuration [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :scalable_matrix_with_unit_pricing] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # scalable_matrix_with_unit_pricing_config:, - # dimensional_price_configuration: nil, - # model_type: :scalable_matrix_with_unit_pricing, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, scalable_matrix_with_unit_pricing_config:, dimensional_price_configuration: nil, model_type: :scalable_matrix_with_unit_pricing) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::ScalableMatrixWithUnitPricingPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Item] + # + # @param maximum [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::PriceType] + # + # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] + # + # @param dimensional_price_configuration [Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :scalable_matrix_with_unit_pricing] # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -11158,12 +10156,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#billing_cycle_configuration @@ -11179,13 +10173,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -11194,11 +10184,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -11213,11 +10200,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#credit_allocation @@ -11232,13 +10216,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#invoicing_cycle_configuration @@ -11254,13 +10234,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -11269,11 +10245,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -11289,13 +10262,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#maximum @@ -11313,13 +10282,15 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Maximum} for more + # details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#minimum @@ -11337,13 +10308,15 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Minimum} for more + # details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#price_type @@ -11353,11 +10326,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#dimensional_price_configuration @@ -11372,13 +10342,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -11517,63 +10483,58 @@ class ScalableMatrixWithTieredPricingPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::CreditAllocation, nil] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Item] - # # @param maximum [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::PriceType] - # # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] - # # @param dimensional_price_configuration [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :scalable_matrix_with_tiered_pricing] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # scalable_matrix_with_tiered_pricing_config:, - # dimensional_price_configuration: nil, - # model_type: :scalable_matrix_with_tiered_pricing, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, scalable_matrix_with_tiered_pricing_config:, dimensional_price_configuration: nil, model_type: :scalable_matrix_with_tiered_pricing) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::ScalableMatrixWithTieredPricingPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::CreditAllocation, nil] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Item] + # + # @param maximum [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::PriceType] + # + # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] + # + # @param dimensional_price_configuration [Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :scalable_matrix_with_tiered_pricing] # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -11582,12 +10543,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#billing_cycle_configuration @@ -11603,13 +10560,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -11618,11 +10571,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -11637,11 +10587,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#credit_allocation @@ -11656,13 +10603,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#invoicing_cycle_configuration @@ -11678,13 +10621,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -11693,11 +10632,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -11713,13 +10649,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#maximum @@ -11737,13 +10669,15 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Maximum} for more + # details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#minimum @@ -11761,13 +10695,15 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Minimum} for more + # details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#price_type @@ -11777,11 +10713,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#dimensional_price_configuration @@ -11796,13 +10729,9 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end @@ -11940,63 +10869,58 @@ class CumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel -> { Orb::Models::Price::CumulativeGroupedBulkPrice::DimensionalPriceConfiguration }, nil?: true - # @!parse - # # @param id [String] - # # @param billable_metric [Orb::Models::Price::CumulativeGroupedBulkPrice::BillableMetric, nil] - # # @param billing_cycle_configuration [Orb::Models::Price::CumulativeGroupedBulkPrice::BillingCycleConfiguration] - # # @param cadence [Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::Cadence] - # # @param conversion_rate [Float, nil] - # # @param created_at [Time] - # # @param credit_allocation [Orb::Models::Price::CumulativeGroupedBulkPrice::CreditAllocation, nil] - # # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] - # # @param currency [String] - # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoicing_cycle_configuration [Orb::Models::Price::CumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] - # # @param item [Orb::Models::Price::CumulativeGroupedBulkPrice::Item] - # # @param maximum [Orb::Models::Price::CumulativeGroupedBulkPrice::Maximum, nil] - # # @param maximum_amount [String, nil] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum [Orb::Models::Price::CumulativeGroupedBulkPrice::Minimum, nil] - # # @param minimum_amount [String, nil] - # # @param name [String] - # # @param plan_phase_order [Integer, nil] - # # @param price_type [Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::PriceType] - # # @param dimensional_price_configuration [Orb::Models::Price::CumulativeGroupedBulkPrice::DimensionalPriceConfiguration, nil] - # # @param model_type [Symbol, :cumulative_grouped_bulk] - # # - # def initialize( - # id:, - # billable_metric:, - # billing_cycle_configuration:, - # cadence:, - # conversion_rate:, - # created_at:, - # credit_allocation:, - # cumulative_grouped_bulk_config:, - # currency:, - # discount:, - # external_price_id:, - # fixed_price_quantity:, - # invoicing_cycle_configuration:, - # item:, - # maximum:, - # maximum_amount:, - # metadata:, - # minimum:, - # minimum_amount:, - # name:, - # plan_phase_order:, - # price_type:, - # dimensional_price_configuration: nil, - # model_type: :cumulative_grouped_bulk, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, created_at:, credit_allocation:, cumulative_grouped_bulk_config:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, dimensional_price_configuration: nil, model_type: :cumulative_grouped_bulk) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::CumulativeGroupedBulkPrice} for more details. + # + # @param id [String] + # + # @param billable_metric [Orb::Models::Price::CumulativeGroupedBulkPrice::BillableMetric, nil] + # + # @param billing_cycle_configuration [Orb::Models::Price::CumulativeGroupedBulkPrice::BillingCycleConfiguration] + # + # @param cadence [Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::Cadence] + # + # @param conversion_rate [Float, nil] + # + # @param created_at [Time] + # + # @param credit_allocation [Orb::Models::Price::CumulativeGroupedBulkPrice::CreditAllocation, nil] + # + # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] + # + # @param currency [String] + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # + # @param external_price_id [String, nil] + # + # @param fixed_price_quantity [Float, nil] + # + # @param invoicing_cycle_configuration [Orb::Models::Price::CumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] + # + # @param item [Orb::Models::Price::CumulativeGroupedBulkPrice::Item] + # + # @param maximum [Orb::Models::Price::CumulativeGroupedBulkPrice::Maximum, nil] + # + # @param maximum_amount [String, nil] + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum [Orb::Models::Price::CumulativeGroupedBulkPrice::Minimum, nil] + # + # @param minimum_amount [String, nil] + # + # @param name [String] + # + # @param plan_phase_order [Integer, nil] + # + # @param price_type [Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::PriceType] + # + # @param dimensional_price_configuration [Orb::Models::Price::CumulativeGroupedBulkPrice::DimensionalPriceConfiguration, nil] + # + # @param model_type [Symbol, :cumulative_grouped_bulk] # @see Orb::Models::Price::CumulativeGroupedBulkPrice#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -12005,12 +10929,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # @see Orb::Models::Price::CumulativeGroupedBulkPrice#billing_cycle_configuration @@ -12026,13 +10946,9 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::CumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::CumulativeGroupedBulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit @@ -12041,11 +10957,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -12060,11 +10973,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::CumulativeGroupedBulkPrice#credit_allocation @@ -12079,13 +10989,9 @@ class CreditAllocation < Orb::Internal::Type::BaseModel # @return [String] required :currency, String - # @!parse - # # @param allows_rollover [Boolean] - # # @param currency [String] - # # - # def initialize(allows_rollover:, currency:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allows_rollover:, currency:) + # @param allows_rollover [Boolean] + # @param currency [String] end # @see Orb::Models::Price::CumulativeGroupedBulkPrice#invoicing_cycle_configuration @@ -12101,13 +11007,9 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::Price::CumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # @param duration [Integer] + # @param duration_unit [Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] # @see Orb::Models::Price::CumulativeGroupedBulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit @@ -12116,11 +11018,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -12136,13 +11035,9 @@ class Item < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::Price::CumulativeGroupedBulkPrice#maximum @@ -12160,13 +11055,14 @@ class Maximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::CumulativeGroupedBulkPrice::Maximum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this maximum amount applies to. For plan/plan phase maxim + # ... + # + # @param maximum_amount [String] Maximum amount applied end # @see Orb::Models::Price::CumulativeGroupedBulkPrice#minimum @@ -12184,13 +11080,14 @@ class Minimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!parse - # # @param applies_to_price_ids [Array] - # # @param minimum_amount [String] - # # - # def initialize(applies_to_price_ids:, minimum_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, minimum_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Price::CumulativeGroupedBulkPrice::Minimum} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this minimum amount applies to. For plan/plan phase minim + # ... + # + # @param minimum_amount [String] Minimum amount applied end # @see Orb::Models::Price::CumulativeGroupedBulkPrice#price_type @@ -12200,11 +11097,8 @@ module PriceType USAGE_PRICE = :usage_price FIXED_PRICE = :fixed_price - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Price::CumulativeGroupedBulkPrice#dimensional_price_configuration @@ -12219,19 +11113,14 @@ class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel # @return [String] required :dimensional_price_group_id, String - # @!parse - # # @param dimension_values [Array] - # # @param dimensional_price_group_id [String] - # # - # def initialize(dimension_values:, dimensional_price_group_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, dimensional_price_group_id:) + # @param dimension_values [Array] + # @param dimensional_price_group_id [String] end end - # @!parse - # # @return [Array(Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice)] end end end diff --git a/lib/orb/models/price_create_params.rb b/lib/orb/models/price_create_params.rb index 4a5f01f1..42edb003 100644 --- a/lib/orb/models/price_create_params.rb +++ b/lib/orb/models/price_create_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Prices#create class PriceCreateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute cadence @@ -245,101 +244,101 @@ class PriceCreateParams < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>Object}] required :cumulative_grouped_bulk_config, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown] - # @!parse - # # @param cadence [Symbol, Orb::Models::PriceCreateParams::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param model_type [Symbol, Orb::Models::PriceCreateParams::ModelType] - # # @param name [String] - # # @param unit_config [Orb::Models::PriceCreateParams::UnitConfig] - # # @param package_config [Orb::Models::PriceCreateParams::PackageConfig] - # # @param matrix_config [Orb::Models::PriceCreateParams::MatrixConfig] - # # @param matrix_with_allocation_config [Orb::Models::PriceCreateParams::MatrixWithAllocationConfig] - # # @param tiered_config [Orb::Models::PriceCreateParams::TieredConfig] - # # @param tiered_bps_config [Orb::Models::PriceCreateParams::TieredBpsConfig] - # # @param bps_config [Orb::Models::PriceCreateParams::BpsConfig] - # # @param bulk_bps_config [Orb::Models::PriceCreateParams::BulkBpsConfig] - # # @param bulk_config [Orb::Models::PriceCreateParams::BulkConfig] - # # @param threshold_total_amount_config [Hash{Symbol=>Object}] - # # @param tiered_package_config [Hash{Symbol=>Object}] - # # @param grouped_tiered_config [Hash{Symbol=>Object}] - # # @param max_group_tiered_package_config [Hash{Symbol=>Object}] - # # @param tiered_with_minimum_config [Hash{Symbol=>Object}] - # # @param package_with_allocation_config [Hash{Symbol=>Object}] - # # @param tiered_package_with_minimum_config [Hash{Symbol=>Object}] - # # @param unit_with_percent_config [Hash{Symbol=>Object}] - # # @param tiered_with_proration_config [Hash{Symbol=>Object}] - # # @param unit_with_proration_config [Hash{Symbol=>Object}] - # # @param grouped_allocation_config [Hash{Symbol=>Object}] - # # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] - # # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] - # # @param matrix_with_display_name_config [Hash{Symbol=>Object}] - # # @param bulk_with_proration_config [Hash{Symbol=>Object}] - # # @param grouped_tiered_package_config [Hash{Symbol=>Object}] - # # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] - # # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] - # # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::PriceCreateParams::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # model_type:, - # name:, - # unit_config:, - # package_config:, - # matrix_config:, - # matrix_with_allocation_config:, - # tiered_config:, - # tiered_bps_config:, - # bps_config:, - # bulk_bps_config:, - # bulk_config:, - # threshold_total_amount_config:, - # tiered_package_config:, - # grouped_tiered_config:, - # max_group_tiered_package_config:, - # tiered_with_minimum_config:, - # package_with_allocation_config:, - # tiered_package_with_minimum_config:, - # unit_with_percent_config:, - # tiered_with_proration_config:, - # unit_with_proration_config:, - # grouped_allocation_config:, - # grouped_with_prorated_minimum_config:, - # grouped_with_metered_minimum_config:, - # matrix_with_display_name_config:, - # bulk_with_proration_config:, - # grouped_tiered_package_config:, - # scalable_matrix_with_unit_pricing_config:, - # scalable_matrix_with_tiered_pricing_config:, - # cumulative_grouped_bulk_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, model_type:, name:, unit_config:, package_config:, matrix_config:, matrix_with_allocation_config:, tiered_config:, tiered_bps_config:, bps_config:, bulk_bps_config:, bulk_config:, threshold_total_amount_config:, tiered_package_config:, grouped_tiered_config:, max_group_tiered_package_config:, tiered_with_minimum_config:, package_with_allocation_config:, tiered_package_with_minimum_config:, unit_with_percent_config:, tiered_with_proration_config:, unit_with_proration_config:, grouped_allocation_config:, grouped_with_prorated_minimum_config:, grouped_with_metered_minimum_config:, matrix_with_display_name_config:, bulk_with_proration_config:, grouped_tiered_package_config:, scalable_matrix_with_unit_pricing_config:, scalable_matrix_with_tiered_pricing_config:, cumulative_grouped_bulk_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::PriceCreateParams} for more details. + # + # @param cadence [Symbol, Orb::Models::PriceCreateParams::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param model_type [Symbol, Orb::Models::PriceCreateParams::ModelType] + # + # @param name [String] The name of the price. + # + # @param unit_config [Orb::Models::PriceCreateParams::UnitConfig] + # + # @param package_config [Orb::Models::PriceCreateParams::PackageConfig] + # + # @param matrix_config [Orb::Models::PriceCreateParams::MatrixConfig] + # + # @param matrix_with_allocation_config [Orb::Models::PriceCreateParams::MatrixWithAllocationConfig] + # + # @param tiered_config [Orb::Models::PriceCreateParams::TieredConfig] + # + # @param tiered_bps_config [Orb::Models::PriceCreateParams::TieredBpsConfig] + # + # @param bps_config [Orb::Models::PriceCreateParams::BpsConfig] + # + # @param bulk_bps_config [Orb::Models::PriceCreateParams::BulkBpsConfig] + # + # @param bulk_config [Orb::Models::PriceCreateParams::BulkConfig] + # + # @param threshold_total_amount_config [Hash{Symbol=>Object}] + # + # @param tiered_package_config [Hash{Symbol=>Object}] + # + # @param grouped_tiered_config [Hash{Symbol=>Object}] + # + # @param max_group_tiered_package_config [Hash{Symbol=>Object}] + # + # @param tiered_with_minimum_config [Hash{Symbol=>Object}] + # + # @param package_with_allocation_config [Hash{Symbol=>Object}] + # + # @param tiered_package_with_minimum_config [Hash{Symbol=>Object}] + # + # @param unit_with_percent_config [Hash{Symbol=>Object}] + # + # @param tiered_with_proration_config [Hash{Symbol=>Object}] + # + # @param unit_with_proration_config [Hash{Symbol=>Object}] + # + # @param grouped_allocation_config [Hash{Symbol=>Object}] + # + # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] + # + # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] + # + # @param matrix_with_display_name_config [Hash{Symbol=>Object}] + # + # @param bulk_with_proration_config [Hash{Symbol=>Object}] + # + # @param grouped_tiered_package_config [Hash{Symbol=>Object}] + # + # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] + # + # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] + # + # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PriceCreateParams::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] # The cadence to bill for this price on. module Cadence @@ -352,11 +351,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end module ModelType @@ -364,11 +360,8 @@ module ModelType CUMULATIVE_GROUPED_BULK = :cumulative_grouped_bulk - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class UnitConfig < Orb::Internal::Type::BaseModel @@ -378,12 +371,8 @@ class UnitConfig < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param unit_amount [String] - # # - # def initialize(unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:) + # @param unit_amount [String] Rate per unit of usage end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -400,16 +389,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -420,11 +406,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -442,16 +425,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -462,11 +442,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -484,13 +461,14 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @return [Integer] required :package_size, Integer - # @!parse - # # @param package_amount [String] - # # @param package_size [Integer] - # # - # def initialize(package_amount:, package_size:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(package_amount:, package_size:) + # Some parameter documentations has been truncated, see + # {Orb::Models::PriceCreateParams::PackageConfig} for more details. + # + # @param package_amount [String] A currency amount to rate usage by + # + # @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide + # ... end class MatrixConfig < Orb::Internal::Type::BaseModel @@ -513,14 +491,12 @@ class MatrixConfig < Orb::Internal::Type::BaseModel required :matrix_values, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue] } - # @!parse - # # @param default_unit_amount [String] - # # @param dimensions [Array] - # # @param matrix_values [Array] - # # - # def initialize(default_unit_amount:, dimensions:, matrix_values:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(default_unit_amount:, dimensions:, matrix_values:) + # @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value + # + # @param dimensions [Array] One or two event property values to evaluate matrix groups by + # + # @param matrix_values [Array] Matrix values for specified matrix grouping keys class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values @@ -537,13 +513,14 @@ class MatrixValue < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param dimension_values [Array] - # # @param unit_amount [String] - # # - # def initialize(dimension_values:, unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, unit_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue} for more details. + # + # @param dimension_values [Array] One or two matrix keys to filter usage to this Matrix value by. For example, ["r + # ... + # + # @param unit_amount [String] Unit price for the specified dimension_values end end @@ -573,15 +550,14 @@ class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel required :matrix_values, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue] } - # @!parse - # # @param allocation [Float] - # # @param default_unit_amount [String] - # # @param dimensions [Array] - # # @param matrix_values [Array] - # # - # def initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:) + # @param allocation [Float] Allocation to be used to calculate the price + # + # @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value + # + # @param dimensions [Array] One or two event property values to evaluate matrix groups by + # + # @param matrix_values [Array] Matrix values for specified matrix grouping keys class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values @@ -598,13 +574,15 @@ class MatrixValue < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param dimension_values [Array] - # # @param unit_amount [String] - # # - # def initialize(dimension_values:, unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, unit_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue} for + # more details. + # + # @param dimension_values [Array] One or two matrix keys to filter usage to this Matrix value by. For example, ["r + # ... + # + # @param unit_amount [String] Unit price for the specified dimension_values end end @@ -615,12 +593,8 @@ class TieredConfig < Orb::Internal::Type::BaseModel # @return [Array] required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::TieredConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Tiers for rating based on total usage quantities into the specified tier class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit @@ -641,14 +615,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :last_unit, Float, nil?: true - # @!parse - # # @param first_unit [Float] - # # @param unit_amount [String] - # # @param last_unit [Float, nil] - # # - # def initialize(first_unit:, unit_amount:, last_unit: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(first_unit:, unit_amount:, last_unit: nil) + # @param first_unit [Float] Exclusive tier starting value + # + # @param unit_amount [String] Amount per unit + # + # @param last_unit [Float, nil] Inclusive tier ending value. If null, this is treated as the last tier end end @@ -661,12 +633,12 @@ class TieredBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::TieredBpsConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::PriceCreateParams::TieredBpsConfig} for more details. + # + # @param tiers [Array] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -693,15 +665,14 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param minimum_amount [String] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Per-event basis point rate + # + # @param minimum_amount [String] Exclusive tier starting value + # + # @param maximum_amount [String, nil] Inclusive tier ending value + # + # @param per_unit_maximum [String, nil] Per unit maximum to charge end end @@ -718,13 +689,10 @@ class BpsConfig < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, per_unit_maximum: nil) + # @param bps [Float] Basis point take rate per event + # + # @param per_unit_maximum [String, nil] Optional currency amount maximum to cap spend per event end class BulkBpsConfig < Orb::Internal::Type::BaseModel @@ -735,12 +703,12 @@ class BulkBpsConfig < Orb::Internal::Type::BaseModel # @return [Array] required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::BulkBpsConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::PriceCreateParams::BulkBpsConfig} for more details. + # + # @param tiers [Array] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -761,14 +729,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Basis points to rate on + # + # @param maximum_amount [String, nil] Upper bound for tier + # + # @param per_unit_maximum [String, nil] The maximum amount to charge for any one event end end @@ -779,12 +745,8 @@ class BulkConfig < Orb::Internal::Type::BaseModel # @return [Array] required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::BulkConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Bulk tiers for rating based on total usage volume class Tier < Orb::Internal::Type::BaseModel # @!attribute unit_amount @@ -799,13 +761,10 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :maximum_units, Float, nil?: true - # @!parse - # # @param unit_amount [String] - # # @param maximum_units [Float, nil] - # # - # def initialize(unit_amount:, maximum_units: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:, maximum_units: nil) + # @param unit_amount [String] Amount per unit + # + # @param maximum_units [Float, nil] Upper bound for this tier end end end diff --git a/lib/orb/models/price_evaluate_params.rb b/lib/orb/models/price_evaluate_params.rb index b7dc5e1f..703a6b6e 100644 --- a/lib/orb/models/price_evaluate_params.rb +++ b/lib/orb/models/price_evaluate_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Prices#evaluate class PriceEvaluateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute timeframe_end @@ -40,7 +39,7 @@ class PriceEvaluateParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :filter, String, nil?: true - # @!attribute [r] grouping_keys + # @!attribute grouping_keys # Properties (or # [computed properties](/extensibility/advanced-metrics#computed-properties)) used # to group the underlying billable metric @@ -48,33 +47,25 @@ class PriceEvaluateParams < Orb::Internal::Type::BaseModel # @return [Array, nil] optional :grouping_keys, Orb::Internal::Type::ArrayOf[String] - # @!parse - # # @return [Array] - # attr_writer :grouping_keys - - # @!parse - # # @param timeframe_end [Time] - # # @param timeframe_start [Time] - # # @param customer_id [String, nil] - # # @param external_customer_id [String, nil] - # # @param filter [String, nil] - # # @param grouping_keys [Array] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # timeframe_end:, - # timeframe_start:, - # customer_id: nil, - # external_customer_id: nil, - # filter: nil, - # grouping_keys: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(timeframe_end:, timeframe_start:, customer_id: nil, external_customer_id: nil, filter: nil, grouping_keys: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::PriceEvaluateParams} for more details. + # + # @param timeframe_end [Time] The exclusive upper bound for event timestamps + # + # @param timeframe_start [Time] The inclusive lower bound for event timestamps + # + # @param customer_id [String, nil] The ID of the customer to which this evaluation is scoped. + # + # @param external_customer_id [String, nil] The external customer ID of the customer to which this evaluation is scoped. + # + # @param filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie + # ... + # + # @param grouping_keys [Array] Properties (or [computed properties](/extensibility/advanced-metrics#computed-pr + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/price_evaluate_response.rb b/lib/orb/models/price_evaluate_response.rb index d0a3794b..96b8be42 100644 --- a/lib/orb/models/price_evaluate_response.rb +++ b/lib/orb/models/price_evaluate_response.rb @@ -9,12 +9,8 @@ class PriceEvaluateResponse < Orb::Internal::Type::BaseModel # @return [Array] required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Models::EvaluatePriceGroup] } - # @!parse - # # @param data [Array] - # # - # def initialize(data:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(data:) + # @param data [Array] end end end diff --git a/lib/orb/models/price_fetch_params.rb b/lib/orb/models/price_fetch_params.rb index 8b8438b7..3e34cda5 100644 --- a/lib/orb/models/price_fetch_params.rb +++ b/lib/orb/models/price_fetch_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Prices#fetch class PriceFetchParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/price_list_params.rb b/lib/orb/models/price_list_params.rb index 148e572e..5581b109 100644 --- a/lib/orb/models/price_list_params.rb +++ b/lib/orb/models/price_list_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Prices#list class PriceListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute cursor @@ -15,24 +14,22 @@ class PriceListParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, limit: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::PriceListParams} for more details. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/price_update_params.rb b/lib/orb/models/price_update_params.rb index a08f0df3..91b0b59f 100644 --- a/lib/orb/models/price_update_params.rb +++ b/lib/orb/models/price_update_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Prices#update class PriceUpdateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute metadata @@ -16,13 +15,14 @@ class PriceUpdateParams < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(metadata: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(metadata: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::PriceUpdateParams} for more details. + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/prices/external_price_id_fetch_params.rb b/lib/orb/models/prices/external_price_id_fetch_params.rb index 921c2a81..d07a30fa 100644 --- a/lib/orb/models/prices/external_price_id_fetch_params.rb +++ b/lib/orb/models/prices/external_price_id_fetch_params.rb @@ -5,16 +5,11 @@ module Models module Prices # @see Orb::Resources::Prices::ExternalPriceID#fetch class ExternalPriceIDFetchParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/prices/external_price_id_update_params.rb b/lib/orb/models/prices/external_price_id_update_params.rb index 7c97e065..879efcad 100644 --- a/lib/orb/models/prices/external_price_id_update_params.rb +++ b/lib/orb/models/prices/external_price_id_update_params.rb @@ -5,8 +5,7 @@ module Models module Prices # @see Orb::Resources::Prices::ExternalPriceID#update class ExternalPriceIDUpdateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute metadata @@ -17,13 +16,14 @@ class ExternalPriceIDUpdateParams < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(metadata: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(metadata: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::Prices::ExternalPriceIDUpdateParams} for more details. + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/subscription.rb b/lib/orb/models/subscription.rb index 5993bc97..c8ac434f 100644 --- a/lib/orb/models/subscription.rb +++ b/lib/orb/models/subscription.rb @@ -198,87 +198,92 @@ class Subscription < Orb::Internal::Type::BaseModel # @return [Orb::Models::Subscription::TrialInfo] required :trial_info, -> { Orb::Models::Subscription::TrialInfo } - # @!parse - # # A [subscription](/core-concepts#subscription) represents the purchase of a plan - # # by a customer. - # # - # # By default, subscriptions begin on the day that they're created and renew - # # automatically for each billing cycle at the cadence that's configured in the - # # plan definition. - # # - # # Subscriptions also default to **beginning of month alignment**, which means the - # # first invoice issued for the subscription will have pro-rated charges between - # # the `start_date` and the first of the following month. Subsequent billing - # # periods will always start and end on a month boundary (e.g. subsequent month - # # starts for monthly billing). - # # - # # Depending on the plan configuration, any _flat_ recurring fees will be billed - # # either at the beginning (in-advance) or end (in-arrears) of each billing cycle. - # # Plans default to **in-advance billing**. Usage-based fees are billed in arrears - # # as usage is accumulated. In the normal course of events, you can expect an - # # invoice to contain usage-based charges for the previous period, and a recurring - # # fee for the following period. - # # - # # @param id [String] - # # @param active_plan_phase_order [Integer, nil] - # # @param adjustment_intervals [Array] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::Subscription::BillingCycleAnchorConfiguration] - # # @param billing_cycle_day [Integer] - # # @param created_at [Time] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param customer [Orb::Models::Customer] - # # @param default_invoice_memo [String, nil] - # # @param discount_intervals [Array] - # # @param end_date [Time, nil] - # # @param fixed_fee_quantity_schedule [Array] - # # @param invoicing_threshold [String, nil] - # # @param maximum_intervals [Array] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum_intervals [Array] - # # @param net_terms [Integer] - # # @param pending_subscription_change [Orb::Models::Subscription::PendingSubscriptionChange, nil] - # # @param plan [Orb::Models::Plan] - # # @param price_intervals [Array] - # # @param redeemed_coupon [Orb::Models::Subscription::RedeemedCoupon, nil] - # # @param start_date [Time] - # # @param status [Symbol, Orb::Models::Subscription::Status] - # # @param trial_info [Orb::Models::Subscription::TrialInfo] - # # - # def initialize( - # id:, - # active_plan_phase_order:, - # adjustment_intervals:, - # auto_collection:, - # billing_cycle_anchor_configuration:, - # billing_cycle_day:, - # created_at:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # customer:, - # default_invoice_memo:, - # discount_intervals:, - # end_date:, - # fixed_fee_quantity_schedule:, - # invoicing_threshold:, - # maximum_intervals:, - # metadata:, - # minimum_intervals:, - # net_terms:, - # pending_subscription_change:, - # plan:, - # price_intervals:, - # redeemed_coupon:, - # start_date:, - # status:, - # trial_info:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Subscription} for more details. + # + # A [subscription](/core-concepts#subscription) represents the purchase of a plan + # by a customer. + # + # By default, subscriptions begin on the day that they're created and renew + # automatically for each billing cycle at the cadence that's configured in the + # plan definition. + # + # Subscriptions also default to **beginning of month alignment**, which means the + # first invoice issued for the subscription will have pro-rated charges between + # the `start_date` and the first of the following month. Subsequent billing + # periods will always start and end on a month boundary (e.g. subsequent month + # starts for monthly billing). + # + # Depending on the plan configuration, any _flat_ recurring fees will be billed + # either at the beginning (in-advance) or end (in-arrears) of each billing cycle. + # Plans default to **in-advance billing**. Usage-based fees are billed in arrears + # as usage is accumulated. In the normal course of events, you can expect an + # invoice to contain usage-based charges for the previous period, and a recurring + # fee for the following period. + # + # @param id [String] + # + # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase + # ... + # + # @param adjustment_intervals [Array] The adjustment intervals for this subscription sorted by the start_date of the a + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::Subscription::BillingCycleAnchorConfiguration] + # + # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param created_at [Time] + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i + # ... + # + # @param discount_intervals [Array] The discount intervals for this subscription sorted by the start_date. + # + # @param end_date [Time, nil] The date Orb stops billing for this subscription. + # + # @param fixed_fee_quantity_schedule [Array] + # + # @param invoicing_threshold [String, nil] + # + # @param maximum_intervals [Array] The maximum intervals for this subscription sorted by the start_date. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum_intervals [Array] The minimum intervals for this subscription sorted by the start_date. + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param pending_subscription_change [Orb::Models::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription. + # + # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # ... + # + # @param price_intervals [Array] The price intervals for this subscription. + # + # @param redeemed_coupon [Orb::Models::Subscription::RedeemedCoupon, nil] + # + # @param start_date [Time] The date Orb starts billing for this subscription. + # + # @param status [Symbol, Orb::Models::Subscription::Status] + # + # @param trial_info [Orb::Models::Subscription::TrialInfo] class AdjustmentInterval < Orb::Internal::Type::BaseModel # @!attribute id @@ -309,16 +314,16 @@ class AdjustmentInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param id [String] - # # @param adjustment [Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) + # @param id [String] + # + # @param adjustment [Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # + # @param applies_to_price_interval_ids [Array] The price interval IDs that this adjustment applies to. + # + # @param end_date [Time, nil] The end date of the adjustment interval. + # + # @param start_date [Time] The start date of the adjustment interval. # @see Orb::Models::Subscription::AdjustmentInterval#adjustment module Adjustment @@ -384,29 +389,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -452,29 +454,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -520,29 +519,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -594,31 +590,28 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -664,34 +657,30 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] end end @@ -721,14 +710,18 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::Subscription::BillingCycleAnchorConfiguration} for more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end module DiscountInterval @@ -778,27 +771,18 @@ class AmountDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param discount_type [Symbol, :amount] - # # - # def initialize( - # amount_discount:, - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # discount_type: :amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount) + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -838,27 +822,23 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param percentage_discount [Float] - # # @param start_date [Time] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # percentage_discount:, - # start_date:, - # discount_type: :percentage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval} for + # more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1 + # ... + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -898,32 +878,27 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # usage_discount:, - # discount_type: :usage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval} for more + # details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval)] end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -947,15 +922,11 @@ class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param end_date [Time, nil] - # # @param price_id [String] - # # @param quantity [Float] - # # @param start_date [Time] - # # - # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, price_id:, quantity:, start_date:) + # @param end_date [Time, nil] + # @param price_id [String] + # @param quantity [Float] + # @param start_date [Time] end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -990,16 +961,20 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param maximum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Subscription::MaximumInterval} for more details. + # + # @param applies_to_price_ids [Array] The price ids that this maximum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this maximum interval applies to. + # + # @param end_date [Time, nil] The end date of the maximum interval. + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the maximum interval. end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1034,16 +1009,20 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param minimum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Subscription::MinimumInterval} for more details. + # + # @param applies_to_price_ids [Array] The price ids that this minimum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this minimum interval applies to. + # + # @param end_date [Time, nil] The end date of the minimum interval. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the minimum interval. end # @see Orb::Models::Subscription#pending_subscription_change @@ -1053,14 +1032,10 @@ class PendingSubscriptionChange < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # A pending subscription change if one exists on this subscription. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # A pending subscription change if one exists on this subscription. + # + # @param id [String] end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1142,39 +1117,40 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. - # # - # # @param id [String] - # # @param billing_cycle_day [Integer] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param end_date [Time, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param start_date [Time] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # billing_cycle_day:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # end_date:, - # filter:, - # fixed_fee_quantity_transitions:, - # price:, - # start_date:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::Subscription::PriceInterval} for more details. + # + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + # + # @param id [String] + # + # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. + # + # @param fixed_fee_quantity_transitions [Array, nil] The fixed fee quantity transitions for this price interval. This is only relevan + # ... + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @!attribute effective_date @@ -1192,14 +1168,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param price_id [String] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, price_id:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, price_id:, quantity:) + # @param effective_date [Time] + # @param price_id [String] + # @param quantity [Integer] end end @@ -1220,14 +1192,10 @@ class RedeemedCoupon < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param coupon_id [String] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(coupon_id:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(coupon_id:, end_date:, start_date:) + # @param coupon_id [String] + # @param end_date [Time, nil] + # @param start_date [Time] end # @see Orb::Models::Subscription#status @@ -1238,11 +1206,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::Subscription#trial_info @@ -1252,12 +1217,8 @@ class TrialInfo < Orb::Internal::Type::BaseModel # @return [Time, nil] required :end_date, Time, nil?: true - # @!parse - # # @param end_date [Time, nil] - # # - # def initialize(end_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:) + # @param end_date [Time, nil] end end end diff --git a/lib/orb/models/subscription_cancel_params.rb b/lib/orb/models/subscription_cancel_params.rb index 649e9f17..daff36d0 100644 --- a/lib/orb/models/subscription_cancel_params.rb +++ b/lib/orb/models/subscription_cancel_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Subscriptions#cancel class SubscriptionCancelParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute cancel_option @@ -29,15 +28,19 @@ class SubscriptionCancelParams < Orb::Internal::Type::BaseModel # @return [Time, nil] optional :cancellation_date, Time, nil?: true - # @!parse - # # @param cancel_option [Symbol, Orb::Models::SubscriptionCancelParams::CancelOption] - # # @param allow_invoice_credit_or_void [Boolean, nil] - # # @param cancellation_date [Time, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cancel_option:, allow_invoice_credit_or_void: nil, cancellation_date: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cancel_option:, allow_invoice_credit_or_void: nil, cancellation_date: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCancelParams} for more details. + # + # @param cancel_option [Symbol, Orb::Models::SubscriptionCancelParams::CancelOption] Determines the timing of subscription cancellation + # + # @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a + # ... + # + # @param cancellation_date [Time, nil] The date that the cancellation should take effect. This parameter can only be pa + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] # Determines the timing of subscription cancellation module CancelOption @@ -47,11 +50,8 @@ module CancelOption IMMEDIATE = :immediate REQUESTED_DATE = :requested_date - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/subscription_cancel_response.rb b/lib/orb/models/subscription_cancel_response.rb index e095986d..7087a85e 100644 --- a/lib/orb/models/subscription_cancel_response.rb +++ b/lib/orb/models/subscription_cancel_response.rb @@ -207,69 +207,75 @@ class SubscriptionCancelResponse < Orb::Internal::Type::BaseModel # @return [Orb::Models::SubscriptionCancelResponse::ChangedResources, nil] optional :changed_resources, -> { Orb::Models::SubscriptionCancelResponse::ChangedResources }, nil?: true - # @!parse - # # @param id [String] - # # @param active_plan_phase_order [Integer, nil] - # # @param adjustment_intervals [Array] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionCancelResponse::BillingCycleAnchorConfiguration] - # # @param billing_cycle_day [Integer] - # # @param created_at [Time] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param customer [Orb::Models::Customer] - # # @param default_invoice_memo [String, nil] - # # @param discount_intervals [Array] - # # @param end_date [Time, nil] - # # @param fixed_fee_quantity_schedule [Array] - # # @param invoicing_threshold [String, nil] - # # @param maximum_intervals [Array] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum_intervals [Array] - # # @param net_terms [Integer] - # # @param pending_subscription_change [Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange, nil] - # # @param plan [Orb::Models::Plan] - # # @param price_intervals [Array] - # # @param redeemed_coupon [Orb::Models::SubscriptionCancelResponse::RedeemedCoupon, nil] - # # @param start_date [Time] - # # @param status [Symbol, Orb::Models::SubscriptionCancelResponse::Status] - # # @param trial_info [Orb::Models::SubscriptionCancelResponse::TrialInfo] - # # @param changed_resources [Orb::Models::SubscriptionCancelResponse::ChangedResources, nil] - # # - # def initialize( - # id:, - # active_plan_phase_order:, - # adjustment_intervals:, - # auto_collection:, - # billing_cycle_anchor_configuration:, - # billing_cycle_day:, - # created_at:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # customer:, - # default_invoice_memo:, - # discount_intervals:, - # end_date:, - # fixed_fee_quantity_schedule:, - # invoicing_threshold:, - # maximum_intervals:, - # metadata:, - # minimum_intervals:, - # net_terms:, - # pending_subscription_change:, - # plan:, - # price_intervals:, - # redeemed_coupon:, - # start_date:, - # status:, - # trial_info:, - # changed_resources: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCancelResponse} for more details. + # + # @param id [String] + # + # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase + # ... + # + # @param adjustment_intervals [Array] The adjustment intervals for this subscription sorted by the start_date of the a + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionCancelResponse::BillingCycleAnchorConfiguration] + # + # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param created_at [Time] + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i + # ... + # + # @param discount_intervals [Array] The discount intervals for this subscription sorted by the start_date. + # + # @param end_date [Time, nil] The date Orb stops billing for this subscription. + # + # @param fixed_fee_quantity_schedule [Array] + # + # @param invoicing_threshold [String, nil] + # + # @param maximum_intervals [Array] The maximum intervals for this subscription sorted by the start_date. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum_intervals [Array] The minimum intervals for this subscription sorted by the start_date. + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param pending_subscription_change [Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription. + # + # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # ... + # + # @param price_intervals [Array] The price intervals for this subscription. + # + # @param redeemed_coupon [Orb::Models::SubscriptionCancelResponse::RedeemedCoupon, nil] + # + # @param start_date [Time] The date Orb starts billing for this subscription. + # + # @param status [Symbol, Orb::Models::SubscriptionCancelResponse::Status] + # + # @param trial_info [Orb::Models::SubscriptionCancelResponse::TrialInfo] + # + # @param changed_resources [Orb::Models::SubscriptionCancelResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet + # ... class AdjustmentInterval < Orb::Internal::Type::BaseModel # @!attribute id @@ -301,16 +307,16 @@ class AdjustmentInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param id [String] - # # @param adjustment [Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) + # @param id [String] + # + # @param adjustment [Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # + # @param applies_to_price_interval_ids [Array] The price interval IDs that this adjustment applies to. + # + # @param end_date [Time, nil] The end date of the adjustment interval. + # + # @param start_date [Time] The start date of the adjustment interval. # @see Orb::Models::SubscriptionCancelResponse::AdjustmentInterval#adjustment module Adjustment @@ -376,29 +382,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -444,29 +447,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -512,29 +512,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -586,31 +583,28 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -656,34 +650,30 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] end end @@ -713,14 +703,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCancelResponse::BillingCycleAnchorConfiguration} for + # more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end module DiscountInterval @@ -771,27 +766,18 @@ class AmountDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param discount_type [Symbol, :amount] - # # - # def initialize( - # amount_discount:, - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # discount_type: :amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount) + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -831,27 +817,23 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param percentage_discount [Float] - # # @param start_date [Time] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # percentage_discount:, - # start_date:, - # discount_type: :percentage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1 + # ... + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -891,32 +873,27 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # usage_discount:, - # discount_type: :usage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionCancelResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionCancelResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval)] end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -940,15 +917,11 @@ class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param end_date [Time, nil] - # # @param price_id [String] - # # @param quantity [Float] - # # @param start_date [Time] - # # - # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, price_id:, quantity:, start_date:) + # @param end_date [Time, nil] + # @param price_id [String] + # @param quantity [Float] + # @param start_date [Time] end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -983,16 +956,20 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param maximum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCancelResponse::MaximumInterval} for more details. + # + # @param applies_to_price_ids [Array] The price ids that this maximum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this maximum interval applies to. + # + # @param end_date [Time, nil] The end date of the maximum interval. + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the maximum interval. end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1027,16 +1004,20 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param minimum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCancelResponse::MinimumInterval} for more details. + # + # @param applies_to_price_ids [Array] The price ids that this minimum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this minimum interval applies to. + # + # @param end_date [Time, nil] The end date of the minimum interval. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the minimum interval. end # @see Orb::Models::SubscriptionCancelResponse#pending_subscription_change @@ -1046,14 +1027,10 @@ class PendingSubscriptionChange < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # A pending subscription change if one exists on this subscription. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # A pending subscription change if one exists on this subscription. + # + # @param id [String] end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1135,39 +1112,40 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. - # # - # # @param id [String] - # # @param billing_cycle_day [Integer] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param end_date [Time, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param start_date [Time] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # billing_cycle_day:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # end_date:, - # filter:, - # fixed_fee_quantity_transitions:, - # price:, - # start_date:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCancelResponse::PriceInterval} for more details. + # + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + # + # @param id [String] + # + # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. + # + # @param fixed_fee_quantity_transitions [Array, nil] The fixed fee quantity transitions for this price interval. This is only relevan + # ... + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @!attribute effective_date @@ -1185,14 +1163,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param price_id [String] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, price_id:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, price_id:, quantity:) + # @param effective_date [Time] + # @param price_id [String] + # @param quantity [Integer] end end @@ -1213,14 +1187,10 @@ class RedeemedCoupon < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param coupon_id [String] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(coupon_id:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(coupon_id:, end_date:, start_date:) + # @param coupon_id [String] + # @param end_date [Time, nil] + # @param start_date [Time] end # @see Orb::Models::SubscriptionCancelResponse#status @@ -1231,11 +1201,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCancelResponse#trial_info @@ -1245,12 +1212,8 @@ class TrialInfo < Orb::Internal::Type::BaseModel # @return [Time, nil] required :end_date, Time, nil?: true - # @!parse - # # @param end_date [Time, nil] - # # - # def initialize(end_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:) + # @param end_date [Time, nil] end # @see Orb::Models::SubscriptionCancelResponse#changed_resources @@ -1279,19 +1242,18 @@ class ChangedResources < Orb::Internal::Type::BaseModel # @return [Array] required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } - # @!parse - # # The resources that were changed as part of this operation. Only present when - # # fetched through the subscription changes API or if the - # # `include_changed_resources` parameter was passed in the request. - # # - # # @param created_credit_notes [Array] - # # @param created_invoices [Array] - # # @param voided_credit_notes [Array] - # # @param voided_invoices [Array] - # # - # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:) + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @param created_credit_notes [Array] The credit notes that were created as part of this operation. + # + # @param created_invoices [Array] The invoices that were created as part of this operation. + # + # @param voided_credit_notes [Array] The credit notes that were voided as part of this operation. + # + # @param voided_invoices [Array] The invoices that were voided as part of this operation. end end end diff --git a/lib/orb/models/subscription_change_apply_params.rb b/lib/orb/models/subscription_change_apply_params.rb index a20f0e4b..8a2c1c21 100644 --- a/lib/orb/models/subscription_change_apply_params.rb +++ b/lib/orb/models/subscription_change_apply_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::SubscriptionChanges#apply class SubscriptionChangeApplyParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute description @@ -20,14 +19,12 @@ class SubscriptionChangeApplyParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :previously_collected_amount, String, nil?: true - # @!parse - # # @param description [String, nil] - # # @param previously_collected_amount [String, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(description: nil, previously_collected_amount: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(description: nil, previously_collected_amount: nil, request_options: {}) + # @param description [String, nil] Description to apply to the balance transaction representing this credit. + # + # @param previously_collected_amount [String, nil] Amount already collected to apply to the customer's balance. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/subscription_change_apply_response.rb b/lib/orb/models/subscription_change_apply_response.rb index 0317ff4f..c58dca9a 100644 --- a/lib/orb/models/subscription_change_apply_response.rb +++ b/lib/orb/models/subscription_change_apply_response.rb @@ -37,22 +37,27 @@ class SubscriptionChangeApplyResponse < Orb::Internal::Type::BaseModel # @return [Time, nil] optional :cancelled_at, Time, nil?: true - # @!parse - # # A subscription change represents a desired new subscription / pending change to - # # an existing subscription. It is a way to first preview the effects on the - # # subscription as well as any changes/creation of invoices (see - # # `subscription.changed_resources`). - # # - # # @param id [String] - # # @param expiration_time [Time] - # # @param status [Symbol, Orb::Models::SubscriptionChangeApplyResponse::Status] - # # @param subscription [Orb::Models::SubscriptionChangeApplyResponse::Subscription, nil] - # # @param applied_at [Time, nil] - # # @param cancelled_at [Time, nil] - # # - # def initialize(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeApplyResponse} for more details. + # + # A subscription change represents a desired new subscription / pending change to + # an existing subscription. It is a way to first preview the effects on the + # subscription as well as any changes/creation of invoices (see + # `subscription.changed_resources`). + # + # @param id [String] + # + # @param expiration_time [Time] Subscription change will be cancelled at this time and can no longer be applied. + # ... + # + # @param status [Symbol, Orb::Models::SubscriptionChangeApplyResponse::Status] + # + # @param subscription [Orb::Models::SubscriptionChangeApplyResponse::Subscription, nil] + # + # @param applied_at [Time, nil] When this change was applied. + # + # @param cancelled_at [Time, nil] When this change was cancelled. # @see Orb::Models::SubscriptionChangeApplyResponse#status module Status @@ -62,11 +67,8 @@ module Status APPLIED = :applied CANCELLED = :cancelled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionChangeApplyResponse#subscription @@ -278,69 +280,75 @@ class Subscription < Orb::Internal::Type::BaseModel -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources }, nil?: true - # @!parse - # # @param id [String] - # # @param active_plan_phase_order [Integer, nil] - # # @param adjustment_intervals [Array] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration] - # # @param billing_cycle_day [Integer] - # # @param created_at [Time] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param customer [Orb::Models::Customer] - # # @param default_invoice_memo [String, nil] - # # @param discount_intervals [Array] - # # @param end_date [Time, nil] - # # @param fixed_fee_quantity_schedule [Array] - # # @param invoicing_threshold [String, nil] - # # @param maximum_intervals [Array] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum_intervals [Array] - # # @param net_terms [Integer] - # # @param pending_subscription_change [Orb::Models::SubscriptionChangeApplyResponse::Subscription::PendingSubscriptionChange, nil] - # # @param plan [Orb::Models::Plan] - # # @param price_intervals [Array] - # # @param redeemed_coupon [Orb::Models::SubscriptionChangeApplyResponse::Subscription::RedeemedCoupon, nil] - # # @param start_date [Time] - # # @param status [Symbol, Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status] - # # @param trial_info [Orb::Models::SubscriptionChangeApplyResponse::Subscription::TrialInfo] - # # @param changed_resources [Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources, nil] - # # - # def initialize( - # id:, - # active_plan_phase_order:, - # adjustment_intervals:, - # auto_collection:, - # billing_cycle_anchor_configuration:, - # billing_cycle_day:, - # created_at:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # customer:, - # default_invoice_memo:, - # discount_intervals:, - # end_date:, - # fixed_fee_quantity_schedule:, - # invoicing_threshold:, - # maximum_intervals:, - # metadata:, - # minimum_intervals:, - # net_terms:, - # pending_subscription_change:, - # plan:, - # price_intervals:, - # redeemed_coupon:, - # start_date:, - # status:, - # trial_info:, - # changed_resources: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeApplyResponse::Subscription} for more details. + # + # @param id [String] + # + # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase + # ... + # + # @param adjustment_intervals [Array] The adjustment intervals for this subscription sorted by the start_date of the a + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration] + # + # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param created_at [Time] + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i + # ... + # + # @param discount_intervals [Array] The discount intervals for this subscription sorted by the start_date. + # + # @param end_date [Time, nil] The date Orb stops billing for this subscription. + # + # @param fixed_fee_quantity_schedule [Array] + # + # @param invoicing_threshold [String, nil] + # + # @param maximum_intervals [Array] The maximum intervals for this subscription sorted by the start_date. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum_intervals [Array] The minimum intervals for this subscription sorted by the start_date. + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param pending_subscription_change [Orb::Models::SubscriptionChangeApplyResponse::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription. + # + # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # ... + # + # @param price_intervals [Array] The price intervals for this subscription. + # + # @param redeemed_coupon [Orb::Models::SubscriptionChangeApplyResponse::Subscription::RedeemedCoupon, nil] + # + # @param start_date [Time] The date Orb starts billing for this subscription. + # + # @param status [Symbol, Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status] + # + # @param trial_info [Orb::Models::SubscriptionChangeApplyResponse::Subscription::TrialInfo] + # + # @param changed_resources [Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet + # ... class AdjustmentInterval < Orb::Internal::Type::BaseModel # @!attribute id @@ -372,16 +380,16 @@ class AdjustmentInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param id [String] - # # @param adjustment [Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) + # @param id [String] + # + # @param adjustment [Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # + # @param applies_to_price_interval_ids [Array] The price interval IDs that this adjustment applies to. + # + # @param end_date [Time, nil] The end date of the adjustment interval. + # + # @param start_date [Time] The start date of the adjustment interval. # @see Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval#adjustment module Adjustment @@ -447,29 +455,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -515,29 +520,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -583,29 +585,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -657,31 +656,28 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -727,34 +723,30 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] end end @@ -784,14 +776,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration} + # for more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end module DiscountInterval @@ -844,27 +841,18 @@ class AmountDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param discount_type [Symbol, :amount] - # # - # def initialize( - # amount_discount:, - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # discount_type: :amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount) + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -904,27 +892,23 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param percentage_discount [Float] - # # @param start_date [Time] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # percentage_discount:, - # start_date:, - # discount_type: :percentage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::PercentageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1 + # ... + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -964,32 +948,27 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # usage_discount:, - # discount_type: :usage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::UsageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::UsageDiscountInterval)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::UsageDiscountInterval)] end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -1013,15 +992,11 @@ class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param end_date [Time, nil] - # # @param price_id [String] - # # @param quantity [Float] - # # @param start_date [Time] - # # - # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, price_id:, quantity:, start_date:) + # @param end_date [Time, nil] + # @param price_id [String] + # @param quantity [Float] + # @param start_date [Time] end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -1056,16 +1031,21 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param maximum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeApplyResponse::Subscription::MaximumInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this maximum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this maximum interval applies to. + # + # @param end_date [Time, nil] The end date of the maximum interval. + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the maximum interval. end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1100,16 +1080,21 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param minimum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeApplyResponse::Subscription::MinimumInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this minimum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this minimum interval applies to. + # + # @param end_date [Time, nil] The end date of the minimum interval. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the minimum interval. end # @see Orb::Models::SubscriptionChangeApplyResponse::Subscription#pending_subscription_change @@ -1119,14 +1104,10 @@ class PendingSubscriptionChange < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # A pending subscription change if one exists on this subscription. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # A pending subscription change if one exists on this subscription. + # + # @param id [String] end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1208,39 +1189,41 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. - # # - # # @param id [String] - # # @param billing_cycle_day [Integer] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param end_date [Time, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param start_date [Time] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # billing_cycle_day:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # end_date:, - # filter:, - # fixed_fee_quantity_transitions:, - # price:, - # start_date:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval} for + # more details. + # + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + # + # @param id [String] + # + # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. + # + # @param fixed_fee_quantity_transitions [Array, nil] The fixed fee quantity transitions for this price interval. This is only relevan + # ... + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @!attribute effective_date @@ -1258,14 +1241,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param price_id [String] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, price_id:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, price_id:, quantity:) + # @param effective_date [Time] + # @param price_id [String] + # @param quantity [Integer] end end @@ -1286,14 +1265,10 @@ class RedeemedCoupon < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param coupon_id [String] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(coupon_id:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(coupon_id:, end_date:, start_date:) + # @param coupon_id [String] + # @param end_date [Time, nil] + # @param start_date [Time] end # @see Orb::Models::SubscriptionChangeApplyResponse::Subscription#status @@ -1304,11 +1279,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionChangeApplyResponse::Subscription#trial_info @@ -1318,12 +1290,8 @@ class TrialInfo < Orb::Internal::Type::BaseModel # @return [Time, nil] required :end_date, Time, nil?: true - # @!parse - # # @param end_date [Time, nil] - # # - # def initialize(end_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:) + # @param end_date [Time, nil] end # @see Orb::Models::SubscriptionChangeApplyResponse::Subscription#changed_resources @@ -1352,19 +1320,18 @@ class ChangedResources < Orb::Internal::Type::BaseModel # @return [Array] required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } - # @!parse - # # The resources that were changed as part of this operation. Only present when - # # fetched through the subscription changes API or if the - # # `include_changed_resources` parameter was passed in the request. - # # - # # @param created_credit_notes [Array] - # # @param created_invoices [Array] - # # @param voided_credit_notes [Array] - # # @param voided_invoices [Array] - # # - # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:) + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @param created_credit_notes [Array] The credit notes that were created as part of this operation. + # + # @param created_invoices [Array] The invoices that were created as part of this operation. + # + # @param voided_credit_notes [Array] The credit notes that were voided as part of this operation. + # + # @param voided_invoices [Array] The invoices that were voided as part of this operation. end end end diff --git a/lib/orb/models/subscription_change_cancel_params.rb b/lib/orb/models/subscription_change_cancel_params.rb index 44e39d1b..663660e0 100644 --- a/lib/orb/models/subscription_change_cancel_params.rb +++ b/lib/orb/models/subscription_change_cancel_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::SubscriptionChanges#cancel class SubscriptionChangeCancelParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/subscription_change_cancel_response.rb b/lib/orb/models/subscription_change_cancel_response.rb index 44f64e33..4d8b1e82 100644 --- a/lib/orb/models/subscription_change_cancel_response.rb +++ b/lib/orb/models/subscription_change_cancel_response.rb @@ -37,22 +37,27 @@ class SubscriptionChangeCancelResponse < Orb::Internal::Type::BaseModel # @return [Time, nil] optional :cancelled_at, Time, nil?: true - # @!parse - # # A subscription change represents a desired new subscription / pending change to - # # an existing subscription. It is a way to first preview the effects on the - # # subscription as well as any changes/creation of invoices (see - # # `subscription.changed_resources`). - # # - # # @param id [String] - # # @param expiration_time [Time] - # # @param status [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Status] - # # @param subscription [Orb::Models::SubscriptionChangeCancelResponse::Subscription, nil] - # # @param applied_at [Time, nil] - # # @param cancelled_at [Time, nil] - # # - # def initialize(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeCancelResponse} for more details. + # + # A subscription change represents a desired new subscription / pending change to + # an existing subscription. It is a way to first preview the effects on the + # subscription as well as any changes/creation of invoices (see + # `subscription.changed_resources`). + # + # @param id [String] + # + # @param expiration_time [Time] Subscription change will be cancelled at this time and can no longer be applied. + # ... + # + # @param status [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Status] + # + # @param subscription [Orb::Models::SubscriptionChangeCancelResponse::Subscription, nil] + # + # @param applied_at [Time, nil] When this change was applied. + # + # @param cancelled_at [Time, nil] When this change was cancelled. # @see Orb::Models::SubscriptionChangeCancelResponse#status module Status @@ -62,11 +67,8 @@ module Status APPLIED = :applied CANCELLED = :cancelled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionChangeCancelResponse#subscription @@ -278,69 +280,75 @@ class Subscription < Orb::Internal::Type::BaseModel -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::ChangedResources }, nil?: true - # @!parse - # # @param id [String] - # # @param active_plan_phase_order [Integer, nil] - # # @param adjustment_intervals [Array] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionChangeCancelResponse::Subscription::BillingCycleAnchorConfiguration] - # # @param billing_cycle_day [Integer] - # # @param created_at [Time] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param customer [Orb::Models::Customer] - # # @param default_invoice_memo [String, nil] - # # @param discount_intervals [Array] - # # @param end_date [Time, nil] - # # @param fixed_fee_quantity_schedule [Array] - # # @param invoicing_threshold [String, nil] - # # @param maximum_intervals [Array] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum_intervals [Array] - # # @param net_terms [Integer] - # # @param pending_subscription_change [Orb::Models::SubscriptionChangeCancelResponse::Subscription::PendingSubscriptionChange, nil] - # # @param plan [Orb::Models::Plan] - # # @param price_intervals [Array] - # # @param redeemed_coupon [Orb::Models::SubscriptionChangeCancelResponse::Subscription::RedeemedCoupon, nil] - # # @param start_date [Time] - # # @param status [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status] - # # @param trial_info [Orb::Models::SubscriptionChangeCancelResponse::Subscription::TrialInfo] - # # @param changed_resources [Orb::Models::SubscriptionChangeCancelResponse::Subscription::ChangedResources, nil] - # # - # def initialize( - # id:, - # active_plan_phase_order:, - # adjustment_intervals:, - # auto_collection:, - # billing_cycle_anchor_configuration:, - # billing_cycle_day:, - # created_at:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # customer:, - # default_invoice_memo:, - # discount_intervals:, - # end_date:, - # fixed_fee_quantity_schedule:, - # invoicing_threshold:, - # maximum_intervals:, - # metadata:, - # minimum_intervals:, - # net_terms:, - # pending_subscription_change:, - # plan:, - # price_intervals:, - # redeemed_coupon:, - # start_date:, - # status:, - # trial_info:, - # changed_resources: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeCancelResponse::Subscription} for more details. + # + # @param id [String] + # + # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase + # ... + # + # @param adjustment_intervals [Array] The adjustment intervals for this subscription sorted by the start_date of the a + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionChangeCancelResponse::Subscription::BillingCycleAnchorConfiguration] + # + # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param created_at [Time] + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i + # ... + # + # @param discount_intervals [Array] The discount intervals for this subscription sorted by the start_date. + # + # @param end_date [Time, nil] The date Orb stops billing for this subscription. + # + # @param fixed_fee_quantity_schedule [Array] + # + # @param invoicing_threshold [String, nil] + # + # @param maximum_intervals [Array] The maximum intervals for this subscription sorted by the start_date. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum_intervals [Array] The minimum intervals for this subscription sorted by the start_date. + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param pending_subscription_change [Orb::Models::SubscriptionChangeCancelResponse::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription. + # + # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # ... + # + # @param price_intervals [Array] The price intervals for this subscription. + # + # @param redeemed_coupon [Orb::Models::SubscriptionChangeCancelResponse::Subscription::RedeemedCoupon, nil] + # + # @param start_date [Time] The date Orb starts billing for this subscription. + # + # @param status [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status] + # + # @param trial_info [Orb::Models::SubscriptionChangeCancelResponse::Subscription::TrialInfo] + # + # @param changed_resources [Orb::Models::SubscriptionChangeCancelResponse::Subscription::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet + # ... class AdjustmentInterval < Orb::Internal::Type::BaseModel # @!attribute id @@ -372,16 +380,16 @@ class AdjustmentInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param id [String] - # # @param adjustment [Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) + # @param id [String] + # + # @param adjustment [Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # + # @param applies_to_price_interval_ids [Array] The price interval IDs that this adjustment applies to. + # + # @param end_date [Time, nil] The end date of the adjustment interval. + # + # @param start_date [Time] The start date of the adjustment interval. # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval#adjustment module Adjustment @@ -447,29 +455,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -515,29 +520,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -583,29 +585,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -657,31 +656,28 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -727,34 +723,30 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] end end @@ -784,14 +776,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::BillingCycleAnchorConfiguration} + # for more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end module DiscountInterval @@ -844,27 +841,18 @@ class AmountDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param discount_type [Symbol, :amount] - # # - # def initialize( - # amount_discount:, - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # discount_type: :amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount) + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -904,27 +892,23 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param percentage_discount [Float] - # # @param start_date [Time] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # percentage_discount:, - # start_date:, - # discount_type: :percentage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::PercentageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1 + # ... + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -964,32 +948,27 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # usage_discount:, - # discount_type: :usage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::UsageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::UsageDiscountInterval)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::UsageDiscountInterval)] end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -1013,15 +992,11 @@ class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param end_date [Time, nil] - # # @param price_id [String] - # # @param quantity [Float] - # # @param start_date [Time] - # # - # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, price_id:, quantity:, start_date:) + # @param end_date [Time, nil] + # @param price_id [String] + # @param quantity [Float] + # @param start_date [Time] end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -1056,16 +1031,21 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param maximum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this maximum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this maximum interval applies to. + # + # @param end_date [Time, nil] The end date of the maximum interval. + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the maximum interval. end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1100,16 +1080,21 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param minimum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this minimum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this minimum interval applies to. + # + # @param end_date [Time, nil] The end date of the minimum interval. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the minimum interval. end # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#pending_subscription_change @@ -1119,14 +1104,10 @@ class PendingSubscriptionChange < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # A pending subscription change if one exists on this subscription. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # A pending subscription change if one exists on this subscription. + # + # @param id [String] end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1208,39 +1189,41 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. - # # - # # @param id [String] - # # @param billing_cycle_day [Integer] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param end_date [Time, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param start_date [Time] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # billing_cycle_day:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # end_date:, - # filter:, - # fixed_fee_quantity_transitions:, - # price:, - # start_date:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval} for + # more details. + # + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + # + # @param id [String] + # + # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. + # + # @param fixed_fee_quantity_transitions [Array, nil] The fixed fee quantity transitions for this price interval. This is only relevan + # ... + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @!attribute effective_date @@ -1258,14 +1241,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param price_id [String] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, price_id:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, price_id:, quantity:) + # @param effective_date [Time] + # @param price_id [String] + # @param quantity [Integer] end end @@ -1286,14 +1265,10 @@ class RedeemedCoupon < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param coupon_id [String] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(coupon_id:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(coupon_id:, end_date:, start_date:) + # @param coupon_id [String] + # @param end_date [Time, nil] + # @param start_date [Time] end # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#status @@ -1304,11 +1279,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#trial_info @@ -1318,12 +1290,8 @@ class TrialInfo < Orb::Internal::Type::BaseModel # @return [Time, nil] required :end_date, Time, nil?: true - # @!parse - # # @param end_date [Time, nil] - # # - # def initialize(end_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:) + # @param end_date [Time, nil] end # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#changed_resources @@ -1352,19 +1320,18 @@ class ChangedResources < Orb::Internal::Type::BaseModel # @return [Array] required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } - # @!parse - # # The resources that were changed as part of this operation. Only present when - # # fetched through the subscription changes API or if the - # # `include_changed_resources` parameter was passed in the request. - # # - # # @param created_credit_notes [Array] - # # @param created_invoices [Array] - # # @param voided_credit_notes [Array] - # # @param voided_invoices [Array] - # # - # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:) + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @param created_credit_notes [Array] The credit notes that were created as part of this operation. + # + # @param created_invoices [Array] The invoices that were created as part of this operation. + # + # @param voided_credit_notes [Array] The credit notes that were voided as part of this operation. + # + # @param voided_invoices [Array] The invoices that were voided as part of this operation. end end end diff --git a/lib/orb/models/subscription_change_retrieve_params.rb b/lib/orb/models/subscription_change_retrieve_params.rb index 358acf42..983fb496 100644 --- a/lib/orb/models/subscription_change_retrieve_params.rb +++ b/lib/orb/models/subscription_change_retrieve_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::SubscriptionChanges#retrieve class SubscriptionChangeRetrieveParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/subscription_change_retrieve_response.rb b/lib/orb/models/subscription_change_retrieve_response.rb index 572e8c8d..767d56f7 100644 --- a/lib/orb/models/subscription_change_retrieve_response.rb +++ b/lib/orb/models/subscription_change_retrieve_response.rb @@ -37,22 +37,27 @@ class SubscriptionChangeRetrieveResponse < Orb::Internal::Type::BaseModel # @return [Time, nil] optional :cancelled_at, Time, nil?: true - # @!parse - # # A subscription change represents a desired new subscription / pending change to - # # an existing subscription. It is a way to first preview the effects on the - # # subscription as well as any changes/creation of invoices (see - # # `subscription.changed_resources`). - # # - # # @param id [String] - # # @param expiration_time [Time] - # # @param status [Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Status] - # # @param subscription [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription, nil] - # # @param applied_at [Time, nil] - # # @param cancelled_at [Time, nil] - # # - # def initialize(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeRetrieveResponse} for more details. + # + # A subscription change represents a desired new subscription / pending change to + # an existing subscription. It is a way to first preview the effects on the + # subscription as well as any changes/creation of invoices (see + # `subscription.changed_resources`). + # + # @param id [String] + # + # @param expiration_time [Time] Subscription change will be cancelled at this time and can no longer be applied. + # ... + # + # @param status [Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Status] + # + # @param subscription [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription, nil] + # + # @param applied_at [Time, nil] When this change was applied. + # + # @param cancelled_at [Time, nil] When this change was cancelled. # @see Orb::Models::SubscriptionChangeRetrieveResponse#status module Status @@ -62,11 +67,8 @@ module Status APPLIED = :applied CANCELLED = :cancelled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionChangeRetrieveResponse#subscription @@ -278,69 +280,76 @@ class Subscription < Orb::Internal::Type::BaseModel -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources }, nil?: true - # @!parse - # # @param id [String] - # # @param active_plan_phase_order [Integer, nil] - # # @param adjustment_intervals [Array] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration] - # # @param billing_cycle_day [Integer] - # # @param created_at [Time] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param customer [Orb::Models::Customer] - # # @param default_invoice_memo [String, nil] - # # @param discount_intervals [Array] - # # @param end_date [Time, nil] - # # @param fixed_fee_quantity_schedule [Array] - # # @param invoicing_threshold [String, nil] - # # @param maximum_intervals [Array] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum_intervals [Array] - # # @param net_terms [Integer] - # # @param pending_subscription_change [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange, nil] - # # @param plan [Orb::Models::Plan] - # # @param price_intervals [Array] - # # @param redeemed_coupon [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon, nil] - # # @param start_date [Time] - # # @param status [Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status] - # # @param trial_info [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo] - # # @param changed_resources [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources, nil] - # # - # def initialize( - # id:, - # active_plan_phase_order:, - # adjustment_intervals:, - # auto_collection:, - # billing_cycle_anchor_configuration:, - # billing_cycle_day:, - # created_at:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # customer:, - # default_invoice_memo:, - # discount_intervals:, - # end_date:, - # fixed_fee_quantity_schedule:, - # invoicing_threshold:, - # maximum_intervals:, - # metadata:, - # minimum_intervals:, - # net_terms:, - # pending_subscription_change:, - # plan:, - # price_intervals:, - # redeemed_coupon:, - # start_date:, - # status:, - # trial_info:, - # changed_resources: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription} for more + # details. + # + # @param id [String] + # + # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase + # ... + # + # @param adjustment_intervals [Array] The adjustment intervals for this subscription sorted by the start_date of the a + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration] + # + # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param created_at [Time] + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i + # ... + # + # @param discount_intervals [Array] The discount intervals for this subscription sorted by the start_date. + # + # @param end_date [Time, nil] The date Orb stops billing for this subscription. + # + # @param fixed_fee_quantity_schedule [Array] + # + # @param invoicing_threshold [String, nil] + # + # @param maximum_intervals [Array] The maximum intervals for this subscription sorted by the start_date. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum_intervals [Array] The minimum intervals for this subscription sorted by the start_date. + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param pending_subscription_change [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription. + # + # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # ... + # + # @param price_intervals [Array] The price intervals for this subscription. + # + # @param redeemed_coupon [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon, nil] + # + # @param start_date [Time] The date Orb starts billing for this subscription. + # + # @param status [Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status] + # + # @param trial_info [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo] + # + # @param changed_resources [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet + # ... class AdjustmentInterval < Orb::Internal::Type::BaseModel # @!attribute id @@ -372,16 +381,16 @@ class AdjustmentInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param id [String] - # # @param adjustment [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) + # @param id [String] + # + # @param adjustment [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # + # @param applies_to_price_interval_ids [Array] The price interval IDs that this adjustment applies to. + # + # @param end_date [Time, nil] The end date of the adjustment interval. + # + # @param start_date [Time] The start date of the adjustment interval. # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval#adjustment module Adjustment @@ -447,29 +456,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -515,29 +521,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -583,29 +586,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -657,31 +657,28 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -727,34 +724,30 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] end end @@ -784,14 +777,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration} + # for more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end module DiscountInterval @@ -844,27 +842,18 @@ class AmountDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param discount_type [Symbol, :amount] - # # - # def initialize( - # amount_discount:, - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # discount_type: :amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount) + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -904,27 +893,23 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param percentage_discount [Float] - # # @param start_date [Time] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # percentage_discount:, - # start_date:, - # discount_type: :percentage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1 + # ... + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -964,32 +949,27 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # usage_discount:, - # discount_type: :usage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval)] end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -1013,15 +993,11 @@ class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param end_date [Time, nil] - # # @param price_id [String] - # # @param quantity [Float] - # # @param start_date [Time] - # # - # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, price_id:, quantity:, start_date:) + # @param end_date [Time, nil] + # @param price_id [String] + # @param quantity [Float] + # @param start_date [Time] end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -1056,16 +1032,21 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param maximum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this maximum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this maximum interval applies to. + # + # @param end_date [Time, nil] The end date of the maximum interval. + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the maximum interval. end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1100,16 +1081,21 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param minimum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this minimum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this minimum interval applies to. + # + # @param end_date [Time, nil] The end date of the minimum interval. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the minimum interval. end # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#pending_subscription_change @@ -1119,14 +1105,10 @@ class PendingSubscriptionChange < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # A pending subscription change if one exists on this subscription. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # A pending subscription change if one exists on this subscription. + # + # @param id [String] end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1208,39 +1190,41 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. - # # - # # @param id [String] - # # @param billing_cycle_day [Integer] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param end_date [Time, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param start_date [Time] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # billing_cycle_day:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # end_date:, - # filter:, - # fixed_fee_quantity_transitions:, - # price:, - # start_date:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval} + # for more details. + # + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + # + # @param id [String] + # + # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. + # + # @param fixed_fee_quantity_transitions [Array, nil] The fixed fee quantity transitions for this price interval. This is only relevan + # ... + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @!attribute effective_date @@ -1258,14 +1242,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param price_id [String] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, price_id:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, price_id:, quantity:) + # @param effective_date [Time] + # @param price_id [String] + # @param quantity [Integer] end end @@ -1286,14 +1266,10 @@ class RedeemedCoupon < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param coupon_id [String] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(coupon_id:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(coupon_id:, end_date:, start_date:) + # @param coupon_id [String] + # @param end_date [Time, nil] + # @param start_date [Time] end # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#status @@ -1304,11 +1280,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#trial_info @@ -1318,12 +1291,8 @@ class TrialInfo < Orb::Internal::Type::BaseModel # @return [Time, nil] required :end_date, Time, nil?: true - # @!parse - # # @param end_date [Time, nil] - # # - # def initialize(end_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:) + # @param end_date [Time, nil] end # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#changed_resources @@ -1352,19 +1321,18 @@ class ChangedResources < Orb::Internal::Type::BaseModel # @return [Array] required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } - # @!parse - # # The resources that were changed as part of this operation. Only present when - # # fetched through the subscription changes API or if the - # # `include_changed_resources` parameter was passed in the request. - # # - # # @param created_credit_notes [Array] - # # @param created_invoices [Array] - # # @param voided_credit_notes [Array] - # # @param voided_invoices [Array] - # # - # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:) + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @param created_credit_notes [Array] The credit notes that were created as part of this operation. + # + # @param created_invoices [Array] The invoices that were created as part of this operation. + # + # @param voided_credit_notes [Array] The credit notes that were voided as part of this operation. + # + # @param voided_invoices [Array] The invoices that were voided as part of this operation. end end end diff --git a/lib/orb/models/subscription_create_params.rb b/lib/orb/models/subscription_create_params.rb index 1d8483ee..c5ffc795 100644 --- a/lib/orb/models/subscription_create_params.rb +++ b/lib/orb/models/subscription_create_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Subscriptions#create class SubscriptionCreateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute add_adjustments @@ -26,15 +25,11 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionCreateParams::AddPrice] }, nil?: true - # @!attribute [r] align_billing_with_subscription_start_date + # @!attribute align_billing_with_subscription_start_date # # @return [Boolean, nil] optional :align_billing_with_subscription_start_date, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :align_billing_with_subscription_start_date - # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be # charged with the saved payment method on the due date. If not specified, this @@ -44,6 +39,7 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true # @!attribute aws_region + # @deprecated # # @return [String, nil] optional :aws_region, String, nil?: true @@ -64,6 +60,7 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel optional :coupon_redemption_code, String, nil?: true # @!attribute credits_overage_rate + # @deprecated # # @return [Float, nil] optional :credits_overage_rate, Float, nil?: true @@ -91,6 +88,7 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel optional :external_customer_id, String, nil?: true # @!attribute external_marketplace + # @deprecated # # @return [Symbol, Orb::Models::SubscriptionCreateParams::ExternalMarketplace, nil] optional :external_marketplace, @@ -98,6 +96,7 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel nil?: true # @!attribute external_marketplace_reporting_id + # @deprecated # # @return [String, nil] optional :external_marketplace_reporting_id, String, nil?: true @@ -149,6 +148,7 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel optional :net_terms, Integer, nil?: true # @!attribute per_credit_overage_amount + # @deprecated # # @return [Float, nil] optional :per_credit_overage_amount, Float, nil?: true @@ -168,6 +168,8 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel optional :plan_version_number, Integer, nil?: true # @!attribute price_overrides + # @deprecated + # # Optionally provide a list of overrides for prices on the plan # # @return [Array, nil] @@ -234,79 +236,91 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel # @return [Array, nil] optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # @param add_adjustments [Array, nil] - # # @param add_prices [Array, nil] - # # @param align_billing_with_subscription_start_date [Boolean] - # # @param auto_collection [Boolean, nil] - # # @param aws_region [String, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionCreateParams::BillingCycleAnchorConfiguration, nil] - # # @param coupon_redemption_code [String, nil] - # # @param credits_overage_rate [Float, nil] - # # @param customer_id [String, nil] - # # @param default_invoice_memo [String, nil] - # # @param end_date [Time, nil] - # # @param external_customer_id [String, nil] - # # @param external_marketplace [Symbol, Orb::Models::SubscriptionCreateParams::ExternalMarketplace, nil] - # # @param external_marketplace_reporting_id [String, nil] - # # @param external_plan_id [String, nil] - # # @param filter [String, nil] - # # @param initial_phase_order [Integer, nil] - # # @param invoicing_threshold [String, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param net_terms [Integer, nil] - # # @param per_credit_overage_amount [Float, nil] - # # @param plan_id [String, nil] - # # @param plan_version_number [Integer, nil] - # # @param price_overrides [Array, nil] - # # @param remove_adjustments [Array, nil] - # # @param remove_prices [Array, nil] - # # @param replace_adjustments [Array, nil] - # # @param replace_prices [Array, nil] - # # @param start_date [Time, nil] - # # @param trial_duration_days [Integer, nil] - # # @param usage_customer_ids [Array, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # add_adjustments: nil, - # add_prices: nil, - # align_billing_with_subscription_start_date: nil, - # auto_collection: nil, - # aws_region: nil, - # billing_cycle_anchor_configuration: nil, - # coupon_redemption_code: nil, - # credits_overage_rate: nil, - # customer_id: nil, - # default_invoice_memo: nil, - # end_date: nil, - # external_customer_id: nil, - # external_marketplace: nil, - # external_marketplace_reporting_id: nil, - # external_plan_id: nil, - # filter: nil, - # initial_phase_order: nil, - # invoicing_threshold: nil, - # metadata: nil, - # net_terms: nil, - # per_credit_overage_amount: nil, - # plan_id: nil, - # plan_version_number: nil, - # price_overrides: nil, - # remove_adjustments: nil, - # remove_prices: nil, - # replace_adjustments: nil, - # replace_prices: nil, - # start_date: nil, - # trial_duration_days: nil, - # usage_customer_ids: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(add_adjustments: nil, add_prices: nil, align_billing_with_subscription_start_date: nil, auto_collection: nil, aws_region: nil, billing_cycle_anchor_configuration: nil, coupon_redemption_code: nil, credits_overage_rate: nil, customer_id: nil, default_invoice_memo: nil, end_date: nil, external_customer_id: nil, external_marketplace: nil, external_marketplace_reporting_id: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, start_date: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams} for more details. + # + # @param add_adjustments [Array, nil] Additional adjustments to be added to the subscription. (Only available for acco + # ... + # + # @param add_prices [Array, nil] Additional prices to be added to the subscription. (Only available for accounts + # ... + # + # @param align_billing_with_subscription_start_date [Boolean] + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param aws_region [String, nil] + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionCreateParams::BillingCycleAnchorConfiguration, nil] + # + # @param coupon_redemption_code [String, nil] Redemption code to be used for this subscription. If the coupon cannot be found + # ... + # + # @param credits_overage_rate [Float, nil] + # + # @param customer_id [String, nil] + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscription's invoices. Note that if this i + # ... + # + # @param end_date [Time, nil] + # + # @param external_customer_id [String, nil] + # + # @param external_marketplace [Symbol, Orb::Models::SubscriptionCreateParams::ExternalMarketplace, nil] + # + # @param external_marketplace_reporting_id [String, nil] + # + # @param external_plan_id [String, nil] The external_plan_id of the plan that the given subscription should be switched + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. This filter must be expressed as + # ... + # + # @param initial_phase_order [Integer, nil] The phase of the plan to start with + # + # @param invoicing_threshold [String, nil] When this subscription's accrued usage reaches this threshold, an invoice will b + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d + # ... + # + # @param per_credit_overage_amount [Float, nil] + # + # @param plan_id [String, nil] The plan that the given subscription should be switched to. Note that either thi + # ... + # + # @param plan_version_number [Integer, nil] Specifies which version of the plan to subscribe to. If null, the default versio + # ... + # + # @param price_overrides [Array, nil] Optionally provide a list of overrides for prices on the plan + # + # @param remove_adjustments [Array, nil] Plan adjustments to be removed from the subscription. (Only available for accoun + # ... + # + # @param remove_prices [Array, nil] Plan prices to be removed from the subscription. (Only available for accounts th + # ... + # + # @param replace_adjustments [Array, nil] Plan adjustments to be replaced with additional adjustments on the subscription. + # ... + # + # @param replace_prices [Array, nil] Plan prices to be replaced with additional prices on the subscription. (Only ava + # ... + # + # @param start_date [Time, nil] + # + # @param trial_duration_days [Integer, nil] The duration of the trial period in days. If not provided, this defaults to the + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] class AddAdjustment < Orb::Internal::Type::BaseModel # @!attribute adjustment @@ -336,15 +350,19 @@ class AddAdjustment < Orb::Internal::Type::BaseModel # @return [Time, nil] optional :start_date, Time, nil?: true - # @!parse - # # @param adjustment [Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewMaximum] - # # @param end_date [Time, nil] - # # @param plan_phase_order [Integer, nil] - # # @param start_date [Time, nil] - # # - # def initialize(adjustment:, end_date: nil, plan_phase_order: nil, start_date: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(adjustment:, end_date: nil, plan_phase_order: nil, start_date: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddAdjustment} for more details. + # + # @param adjustment [Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewMaximum] The definition of a new adjustment to create and add to the subscription. + # + # @param end_date [Time, nil] The end date of the adjustment interval. This is the date that the adjustment wi + # ... + # + # @param plan_phase_order [Integer, nil] The phase to add this adjustment to. + # + # @param start_date [Time, nil] The start date of the adjustment interval. This is the date that the adjustment + # ... # The definition of a new adjustment to create and add to the subscription. # @@ -384,34 +402,26 @@ class NewPercentageDiscount < Orb::Internal::Type::BaseModel # @return [Float] required :percentage_discount, Float - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param percentage_discount [Float] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # applies_to_price_ids:, - # percentage_discount:, - # is_invoice_level: nil, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, percentage_discount:, is_invoice_level: nil, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewPercentageDiscount} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param percentage_discount [Float] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :percentage_discount] end class NewUsageDiscount < Orb::Internal::Type::BaseModel @@ -431,26 +441,26 @@ class NewUsageDiscount < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param usage_discount [Float] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize(applies_to_price_ids:, usage_discount:, is_invoice_level: nil, adjustment_type: :usage_discount, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, usage_discount:, is_invoice_level: nil, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewUsageDiscount} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param usage_discount [Float] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class NewAmountDiscount < Orb::Internal::Type::BaseModel @@ -470,26 +480,26 @@ class NewAmountDiscount < Orb::Internal::Type::BaseModel # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize(amount_discount:, applies_to_price_ids:, is_invoice_level: nil, adjustment_type: :amount_discount, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, is_invoice_level: nil, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewAmountDiscount} + # for more details. + # + # @param amount_discount [String] + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :amount_discount] end class NewMinimum < Orb::Internal::Type::BaseModel @@ -515,27 +525,28 @@ class NewMinimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize(applies_to_price_ids:, item_id:, minimum_amount:, is_invoice_level: nil, adjustment_type: :minimum, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, item_id:, minimum_amount:, is_invoice_level: nil, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewMinimum} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :minimum] end class NewMaximum < Orb::Internal::Type::BaseModel @@ -555,31 +566,30 @@ class NewMaximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, is_invoice_level: nil, adjustment_type: :maximum, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:, is_invoice_level: nil, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewMaximum} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param maximum_amount [String] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewMaximum)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewMaximum)] end end @@ -593,6 +603,8 @@ class AddPrice < Orb::Internal::Type::BaseModel nil?: true # @!attribute discounts + # @deprecated + # # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for this # price. # @@ -616,6 +628,8 @@ class AddPrice < Orb::Internal::Type::BaseModel optional :external_price_id, String, nil?: true # @!attribute maximum_amount + # @deprecated + # # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for # this price. # @@ -623,6 +637,8 @@ class AddPrice < Orb::Internal::Type::BaseModel optional :maximum_amount, String, nil?: true # @!attribute minimum_amount + # @deprecated + # # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for # this price. # @@ -655,35 +671,34 @@ class AddPrice < Orb::Internal::Type::BaseModel # @return [Time, nil] optional :start_date, Time, nil?: true - # @!parse - # # @param allocation_price [Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice, nil] - # # @param discounts [Array, nil] - # # @param end_date [Time, nil] - # # @param external_price_id [String, nil] - # # @param maximum_amount [String, nil] - # # @param minimum_amount [String, nil] - # # @param plan_phase_order [Integer, nil] - # # @param price [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice, nil] - # # @param price_id [String, nil] - # # @param start_date [Time, nil] - # # - # def initialize( - # allocation_price: nil, - # discounts: nil, - # end_date: nil, - # external_price_id: nil, - # maximum_amount: nil, - # minimum_amount: nil, - # plan_phase_order: nil, - # price: nil, - # price_id: nil, - # start_date: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allocation_price: nil, discounts: nil, end_date: nil, external_price_id: nil, maximum_amount: nil, minimum_amount: nil, plan_phase_order: nil, price: nil, price_id: nil, start_date: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice} for more details. + # + # @param allocation_price [Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice, nil] The definition of a new allocation price to create and add to the subscription. + # + # @param discounts [Array, nil] [DEPRECATED] Use add_adjustments instead. The subscription's discounts for this + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that the price will stop bi + # ... + # + # @param external_price_id [String, nil] The external price id of the price to add to the subscription. + # + # @param maximum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for + # ... + # + # @param minimum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for + # ... + # + # @param plan_phase_order [Integer, nil] The phase to add this price to. + # + # @param price [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice, nil] The definition of a new price to create and add to the subscription. + # + # @param price_id [String, nil] The id of the price to add to the subscription. + # + # @param start_date [Time, nil] The start date of the price interval. This is the date that the price will start + # ... # @see Orb::Models::SubscriptionCreateParams::AddPrice#allocation_price class AllocationPrice < Orb::Internal::Type::BaseModel @@ -713,17 +728,22 @@ class AllocationPrice < Orb::Internal::Type::BaseModel # @return [Boolean] required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean - # @!parse - # # The definition of a new allocation price to create and add to the subscription. - # # - # # @param amount [String] - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::Cadence] - # # @param currency [String] - # # @param expires_at_end_of_cadence [Boolean] - # # - # def initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice} for more + # details. + # + # The definition of a new allocation price to create and add to the subscription. + # + # @param amount [String] An amount of the currency to allocate to the customer at the specified cadence. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::Cadence] The cadence at which to allocate the amount to the customer. + # + # @param currency [String] An ISO 4217 currency string or a custom pricing unit identifier in which to bill + # ... + # + # @param expires_at_end_of_cadence [Boolean] Whether the allocated amount should expire at the end of the cadence or roll ove + # ... # The cadence at which to allocate the amount to the customer. # @@ -738,11 +758,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -773,15 +790,19 @@ class Discount < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :usage_discount, Float, nil?: true - # @!parse - # # @param discount_type [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Discount::DiscountType] - # # @param amount_discount [String, nil] - # # @param percentage_discount [Float, nil] - # # @param usage_discount [Float, nil] - # # - # def initialize(discount_type:, amount_discount: nil, percentage_discount: nil, usage_discount: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(discount_type:, amount_discount: nil, percentage_discount: nil, usage_discount: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Discount} for more details. + # + # @param discount_type [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Discount::DiscountType] + # + # @param amount_discount [String, nil] Only available if discount_type is `amount`. + # + # @param percentage_discount [Float, nil] Only available if discount_type is `percentage`. This is a number between 0 and + # ... + # + # @param usage_discount [Float, nil] Only available if discount_type is `usage`. Number of usage units that this disc + # ... # @see Orb::Models::SubscriptionCreateParams::AddPrice::Discount#discount_type module DiscountType @@ -791,11 +812,8 @@ module DiscountType USAGE = :usage AMOUNT = :amount - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -987,47 +1005,50 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::UnitConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :unit] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :unit, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :unit) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::UnitConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :unit] # The cadence to bill for this price on. # @@ -1042,11 +1063,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice#unit_config @@ -1057,12 +1075,8 @@ class UnitConfig < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param unit_amount [String] - # # - # def initialize(unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:) + # @param unit_amount [String] Rate per unit of usage end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice#billing_cycle_configuration @@ -1080,16 +1094,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1100,11 +1111,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1123,16 +1131,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1143,11 +1148,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1262,47 +1264,50 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param package_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::PackageConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :package] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # package_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param package_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::PackageConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :package] # The cadence to bill for this price on. # @@ -1317,11 +1322,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice#package_config @@ -1339,13 +1341,15 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @return [Integer] required :package_size, Integer - # @!parse - # # @param package_amount [String] - # # @param package_size [Integer] - # # - # def initialize(package_amount:, package_size:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(package_amount:, package_size:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::PackageConfig} + # for more details. + # + # @param package_amount [String] A currency amount to rate usage by + # + # @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide + # ... end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice#billing_cycle_configuration @@ -1363,16 +1367,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1383,11 +1384,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1406,16 +1404,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1426,11 +1421,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1545,47 +1537,50 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence] - # # @param item_id [String] - # # @param matrix_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :matrix] - # # - # def initialize( - # cadence:, - # item_id:, - # matrix_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :matrix, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, matrix_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :matrix) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param matrix_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :matrix] # The cadence to bill for this price on. # @@ -1600,11 +1595,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice#matrix_config @@ -1632,14 +1624,12 @@ class MatrixConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param default_unit_amount [String] - # # @param dimensions [Array] - # # @param matrix_values [Array] - # # - # def initialize(default_unit_amount:, dimensions:, matrix_values:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(default_unit_amount:, dimensions:, matrix_values:) + # @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value + # + # @param dimensions [Array] One or two event property values to evaluate matrix groups by + # + # @param matrix_values [Array] Matrix values for specified matrix grouping keys class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values @@ -1656,13 +1646,15 @@ class MatrixValue < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param dimension_values [Array] - # # @param unit_amount [String] - # # - # def initialize(dimension_values:, unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, unit_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue} + # for more details. + # + # @param dimension_values [Array] One or two matrix keys to filter usage to this Matrix value by. For example, ["r + # ... + # + # @param unit_amount [String] Unit price for the specified dimension_values end end @@ -1681,16 +1673,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1701,11 +1690,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1724,16 +1710,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1744,11 +1727,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1863,47 +1843,50 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered] # The cadence to bill for this price on. # @@ -1918,11 +1901,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice#tiered_config @@ -1934,12 +1914,8 @@ class TieredConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Tiers for rating based on total usage quantities into the specified tier class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit @@ -1960,14 +1936,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :last_unit, Float, nil?: true - # @!parse - # # @param first_unit [Float] - # # @param unit_amount [String] - # # @param last_unit [Float, nil] - # # - # def initialize(first_unit:, unit_amount:, last_unit: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(first_unit:, unit_amount:, last_unit: nil) + # @param first_unit [Float] Exclusive tier starting value + # + # @param unit_amount [String] Amount per unit + # + # @param last_unit [Float, nil] Inclusive tier ending value. If null, this is treated as the last tier end end @@ -1986,16 +1960,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2006,11 +1977,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2029,16 +1997,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2049,11 +2014,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2168,47 +2130,50 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_bps_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_bps] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_bps_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_bps_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_bps] # The cadence to bill for this price on. # @@ -2223,11 +2188,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice#tiered_bps_config @@ -2244,12 +2206,13 @@ class TieredBpsConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig} + # for more details. + # + # @param tiers [Array] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -2276,15 +2239,14 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param minimum_amount [String] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Per-event basis point rate + # + # @param minimum_amount [String] Exclusive tier starting value + # + # @param maximum_amount [String, nil] Inclusive tier ending value + # + # @param per_unit_maximum [String, nil] Per unit maximum to charge end end @@ -2303,16 +2265,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2323,11 +2282,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2346,16 +2302,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2366,11 +2319,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2485,47 +2435,50 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bps_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BpsConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bps] - # # - # def initialize( - # bps_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice} + # for more details. + # + # @param bps_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BpsConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bps] # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice#bps_config class BpsConfig < Orb::Internal::Type::BaseModel @@ -2541,13 +2494,10 @@ class BpsConfig < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, per_unit_maximum: nil) + # @param bps [Float] Basis point take rate per event + # + # @param per_unit_maximum [String, nil] Optional currency amount maximum to cap spend per event end # The cadence to bill for this price on. @@ -2563,11 +2513,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice#billing_cycle_configuration @@ -2585,16 +2532,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2605,11 +2549,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2628,16 +2569,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2648,11 +2586,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2767,47 +2702,50 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bulk_bps_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bulk_bps] - # # - # def initialize( - # bulk_bps_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bulk_bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bulk_bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice} + # for more details. + # + # @param bulk_bps_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bulk_bps] # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice#bulk_bps_config class BulkBpsConfig < Orb::Internal::Type::BaseModel @@ -2819,12 +2757,13 @@ class BulkBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig} + # for more details. + # + # @param tiers [Array] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -2845,14 +2784,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Basis points to rate on + # + # @param maximum_amount [String, nil] Upper bound for tier + # + # @param per_unit_maximum [String, nil] The maximum amount to charge for any one event end end @@ -2869,11 +2806,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice#billing_cycle_configuration @@ -2891,16 +2825,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2911,11 +2842,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2934,16 +2862,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2954,11 +2879,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3073,47 +2995,50 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bulk_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bulk] - # # - # def initialize( - # bulk_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bulk, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bulk) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice} + # for more details. + # + # @param bulk_config [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bulk] # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice#bulk_config class BulkConfig < Orb::Internal::Type::BaseModel @@ -3124,12 +3049,8 @@ class BulkConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Bulk tiers for rating based on total usage volume class Tier < Orb::Internal::Type::BaseModel # @!attribute unit_amount @@ -3144,13 +3065,10 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :maximum_units, Float, nil?: true - # @!parse - # # @param unit_amount [String] - # # @param maximum_units [Float, nil] - # # - # def initialize(unit_amount:, maximum_units: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:, maximum_units: nil) + # @param unit_amount [String] Amount per unit + # + # @param maximum_units [Float, nil] Upper bound for this tier end end @@ -3167,11 +3085,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice#billing_cycle_configuration @@ -3189,16 +3104,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3209,11 +3121,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3232,16 +3141,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3252,11 +3158,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3370,47 +3273,50 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param threshold_total_amount_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :threshold_total_amount] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # threshold_total_amount_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :threshold_total_amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, threshold_total_amount_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :threshold_total_amount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param threshold_total_amount_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :threshold_total_amount] # The cadence to bill for this price on. # @@ -3425,11 +3331,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice#billing_cycle_configuration @@ -3447,16 +3350,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3467,11 +3367,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3490,16 +3387,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3510,11 +3404,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3628,47 +3519,50 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_package_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_package] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_package_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_package_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_package] # The cadence to bill for this price on. # @@ -3683,11 +3577,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice#billing_cycle_configuration @@ -3705,16 +3596,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3725,11 +3613,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3748,16 +3633,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3768,11 +3650,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3886,47 +3765,50 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_with_minimum_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_with_minimum] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_with_minimum_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_with_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_with_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_with_minimum_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_with_minimum] # The cadence to bill for this price on. # @@ -3941,11 +3823,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice#billing_cycle_configuration @@ -3963,16 +3842,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3983,11 +3859,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4006,16 +3879,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4026,11 +3896,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4144,47 +4011,50 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_with_percent_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :unit_with_percent] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_with_percent_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :unit_with_percent, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :unit_with_percent) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_with_percent_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :unit_with_percent] # The cadence to bill for this price on. # @@ -4199,11 +4069,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice#billing_cycle_configuration @@ -4221,16 +4088,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4241,11 +4105,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4264,16 +4125,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4284,11 +4142,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4403,47 +4258,50 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param package_with_allocation_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :package_with_allocation] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # package_with_allocation_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :package_with_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, package_with_allocation_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :package_with_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param package_with_allocation_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :package_with_allocation] # The cadence to bill for this price on. # @@ -4458,11 +4316,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice#billing_cycle_configuration @@ -4480,16 +4335,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4500,11 +4352,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4523,16 +4372,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4543,11 +4389,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4661,47 +4504,50 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_with_proration_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_with_proration] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_with_proration_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_with_proration_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_with_proration] # The cadence to bill for this price on. # @@ -4716,11 +4562,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice#billing_cycle_configuration @@ -4738,16 +4581,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4758,11 +4598,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4781,16 +4618,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4801,11 +4635,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4919,47 +4750,50 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_with_proration_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :unit_with_proration] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_with_proration_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :unit_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :unit_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_with_proration_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :unit_with_proration] # The cadence to bill for this price on. # @@ -4974,11 +4808,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice#billing_cycle_configuration @@ -4996,16 +4827,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5016,11 +4844,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5039,16 +4864,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5059,11 +4881,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5177,66 +4996,66 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence] - # # @param grouped_allocation_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_allocation] - # # - # def initialize( - # cadence:, - # grouped_allocation_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void - - # The cadence to bill for this price on. + # @!method initialize(cadence:, grouped_allocation_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice} + # for more details. # - # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice#cadence - module Cadence - extend Orb::Internal::Type::Enum - - ANNUAL = :annual - SEMI_ANNUAL = :semi_annual - MONTHLY = :monthly - QUARTERLY = :quarterly - ONE_TIME = :one_time - CUSTOM = :custom - - finalize! + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_allocation_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_allocation] - # @!parse - # # @return [Array] - # def self.values; end + # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice#cadence + module Cadence + extend Orb::Internal::Type::Enum + + ANNUAL = :annual + SEMI_ANNUAL = :semi_annual + MONTHLY = :monthly + QUARTERLY = :quarterly + ONE_TIME = :one_time + CUSTOM = :custom + + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice#billing_cycle_configuration @@ -5254,16 +5073,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5274,11 +5090,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5297,16 +5110,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5317,11 +5127,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5436,47 +5243,50 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence] - # # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_with_prorated_minimum] - # # - # def initialize( - # cadence:, - # grouped_with_prorated_minimum_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_with_prorated_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_with_prorated_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_with_prorated_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_with_prorated_minimum] # The cadence to bill for this price on. # @@ -5491,11 +5301,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#billing_cycle_configuration @@ -5513,16 +5320,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5533,11 +5337,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5556,16 +5357,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5576,11 +5374,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5694,47 +5489,50 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bulk_with_proration_config [Hash{Symbol=>Object}] - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bulk_with_proration] - # # - # def initialize( - # bulk_with_proration_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bulk_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_with_proration_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bulk_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice} + # for more details. + # + # @param bulk_with_proration_config [Hash{Symbol=>Object}] + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bulk_with_proration] # The cadence to bill for this price on. # @@ -5749,11 +5547,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice#billing_cycle_configuration @@ -5771,16 +5566,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5791,11 +5583,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5814,16 +5603,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5834,11 +5620,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5953,47 +5736,50 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :scalable_matrix_with_unit_pricing] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # scalable_matrix_with_unit_pricing_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :scalable_matrix_with_unit_pricing, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_unit_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_unit_pricing) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :scalable_matrix_with_unit_pricing] # The cadence to bill for this price on. # @@ -6008,11 +5794,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#billing_cycle_configuration @@ -6030,16 +5813,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6050,11 +5830,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6073,16 +5850,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6093,11 +5867,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6212,47 +5983,50 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :scalable_matrix_with_tiered_pricing] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # scalable_matrix_with_tiered_pricing_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :scalable_matrix_with_tiered_pricing, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_tiered_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_tiered_pricing) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :scalable_matrix_with_tiered_pricing] # The cadence to bill for this price on. # @@ -6267,11 +6041,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#billing_cycle_configuration @@ -6289,16 +6060,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6309,11 +6077,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6332,16 +6097,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6352,11 +6114,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6471,47 +6230,50 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence] - # # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :cumulative_grouped_bulk] - # # - # def initialize( - # cadence:, - # cumulative_grouped_bulk_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :cumulative_grouped_bulk, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, cumulative_grouped_bulk_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :cumulative_grouped_bulk) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence] The cadence to bill for this price on. + # + # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :cumulative_grouped_bulk] # The cadence to bill for this price on. # @@ -6526,11 +6288,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#billing_cycle_configuration @@ -6548,16 +6307,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6568,11 +6324,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6591,16 +6344,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6611,11 +6361,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6730,47 +6477,50 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence] - # # @param item_id [String] - # # @param max_group_tiered_package_config [Hash{Symbol=>Object}] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :max_group_tiered_package] - # # - # def initialize( - # cadence:, - # item_id:, - # max_group_tiered_package_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :max_group_tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, max_group_tiered_package_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :max_group_tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param max_group_tiered_package_config [Hash{Symbol=>Object}] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :max_group_tiered_package] # The cadence to bill for this price on. # @@ -6785,11 +6535,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#billing_cycle_configuration @@ -6807,16 +6554,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6827,11 +6571,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6850,16 +6591,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6870,11 +6608,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6989,47 +6724,50 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence] - # # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_with_metered_minimum] - # # - # def initialize( - # cadence:, - # grouped_with_metered_minimum_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_with_metered_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_with_metered_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_with_metered_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_with_metered_minimum] # The cadence to bill for this price on. # @@ -7044,11 +6782,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#billing_cycle_configuration @@ -7066,16 +6801,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7086,11 +6818,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7109,16 +6838,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7129,11 +6855,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -7248,47 +6971,50 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence] - # # @param item_id [String] - # # @param matrix_with_display_name_config [Hash{Symbol=>Object}] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :matrix_with_display_name] - # # - # def initialize( - # cadence:, - # item_id:, - # matrix_with_display_name_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :matrix_with_display_name, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, matrix_with_display_name_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :matrix_with_display_name) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param matrix_with_display_name_config [Hash{Symbol=>Object}] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :matrix_with_display_name] # The cadence to bill for this price on. # @@ -7303,11 +7029,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#billing_cycle_configuration @@ -7325,16 +7048,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7345,11 +7065,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7368,16 +7085,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7388,11 +7102,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -7506,47 +7217,50 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence] - # # @param grouped_tiered_package_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_tiered_package] - # # - # def initialize( - # cadence:, - # grouped_tiered_package_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_tiered_package_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_tiered_package_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_tiered_package] # The cadence to bill for this price on. # @@ -7561,11 +7275,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice#billing_cycle_configuration @@ -7583,16 +7294,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7603,11 +7311,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7626,16 +7331,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7646,18 +7348,14 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end - # @!parse - # # @return [Array(Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice)] end end @@ -7686,14 +7384,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::BillingCycleAnchorConfiguration} for + # more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end # @deprecated @@ -7704,11 +7407,8 @@ module ExternalMarketplace AWS = :aws AZURE = :azure - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class RemoveAdjustment < Orb::Internal::Type::BaseModel @@ -7718,12 +7418,8 @@ class RemoveAdjustment < Orb::Internal::Type::BaseModel # @return [String] required :adjustment_id, String - # @!parse - # # @param adjustment_id [String] - # # - # def initialize(adjustment_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(adjustment_id:) + # @param adjustment_id [String] The id of the adjustment to remove on the subscription. end class RemovePrice < Orb::Internal::Type::BaseModel @@ -7739,13 +7435,10 @@ class RemovePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :price_id, String, nil?: true - # @!parse - # # @param external_price_id [String, nil] - # # @param price_id [String, nil] - # # - # def initialize(external_price_id: nil, price_id: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(external_price_id: nil, price_id: nil) + # @param external_price_id [String, nil] The external price id of the price to remove on the subscription. + # + # @param price_id [String, nil] The id of the price to remove on the subscription. end class ReplaceAdjustment < Orb::Internal::Type::BaseModel @@ -7761,13 +7454,10 @@ class ReplaceAdjustment < Orb::Internal::Type::BaseModel # @return [String] required :replaces_adjustment_id, String - # @!parse - # # @param adjustment [Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewMaximum] - # # @param replaces_adjustment_id [String] - # # - # def initialize(adjustment:, replaces_adjustment_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(adjustment:, replaces_adjustment_id:) + # @param adjustment [Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewMaximum] The definition of a new adjustment to create and add to the subscription. + # + # @param replaces_adjustment_id [String] The id of the adjustment on the plan to replace in the subscription. # The definition of a new adjustment to create and add to the subscription. # @@ -7807,34 +7497,26 @@ class NewPercentageDiscount < Orb::Internal::Type::BaseModel # @return [Float] required :percentage_discount, Float - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param percentage_discount [Float] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # applies_to_price_ids:, - # percentage_discount:, - # is_invoice_level: nil, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, percentage_discount:, is_invoice_level: nil, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewPercentageDiscount} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param percentage_discount [Float] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :percentage_discount] end class NewUsageDiscount < Orb::Internal::Type::BaseModel @@ -7854,26 +7536,26 @@ class NewUsageDiscount < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param usage_discount [Float] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize(applies_to_price_ids:, usage_discount:, is_invoice_level: nil, adjustment_type: :usage_discount, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, usage_discount:, is_invoice_level: nil, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewUsageDiscount} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param usage_discount [Float] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class NewAmountDiscount < Orb::Internal::Type::BaseModel @@ -7893,26 +7575,26 @@ class NewAmountDiscount < Orb::Internal::Type::BaseModel # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize(amount_discount:, applies_to_price_ids:, is_invoice_level: nil, adjustment_type: :amount_discount, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, is_invoice_level: nil, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewAmountDiscount} + # for more details. + # + # @param amount_discount [String] + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :amount_discount] end class NewMinimum < Orb::Internal::Type::BaseModel @@ -7938,27 +7620,28 @@ class NewMinimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize(applies_to_price_ids:, item_id:, minimum_amount:, is_invoice_level: nil, adjustment_type: :minimum, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, item_id:, minimum_amount:, is_invoice_level: nil, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewMinimum} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :minimum] end class NewMaximum < Orb::Internal::Type::BaseModel @@ -7978,31 +7661,30 @@ class NewMaximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, is_invoice_level: nil, adjustment_type: :maximum, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:, is_invoice_level: nil, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewMaximum} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param maximum_amount [String] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewMaximum)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewMaximum)] end end @@ -8022,6 +7704,8 @@ class ReplacePrice < Orb::Internal::Type::BaseModel nil?: true # @!attribute discounts + # @deprecated + # # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for the # replacement price. # @@ -8043,6 +7727,8 @@ class ReplacePrice < Orb::Internal::Type::BaseModel optional :fixed_price_quantity, Float, nil?: true # @!attribute maximum_amount + # @deprecated + # # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for # the replacement price. # @@ -8050,6 +7736,8 @@ class ReplacePrice < Orb::Internal::Type::BaseModel optional :maximum_amount, String, nil?: true # @!attribute minimum_amount + # @deprecated + # # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for # the replacement price. # @@ -8068,33 +7756,30 @@ class ReplacePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :price_id, String, nil?: true - # @!parse - # # @param replaces_price_id [String] - # # @param allocation_price [Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice, nil] - # # @param discounts [Array, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param maximum_amount [String, nil] - # # @param minimum_amount [String, nil] - # # @param price [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice, nil] - # # @param price_id [String, nil] - # # - # def initialize( - # replaces_price_id:, - # allocation_price: nil, - # discounts: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # maximum_amount: nil, - # minimum_amount: nil, - # price: nil, - # price_id: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(replaces_price_id:, allocation_price: nil, discounts: nil, external_price_id: nil, fixed_price_quantity: nil, maximum_amount: nil, minimum_amount: nil, price: nil, price_id: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice} for more details. + # + # @param replaces_price_id [String] The id of the price on the plan to replace in the subscription. + # + # @param allocation_price [Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice, nil] The definition of a new allocation price to create and add to the subscription. + # + # @param discounts [Array, nil] [DEPRECATED] Use add_adjustments instead. The subscription's discounts for the r + # ... + # + # @param external_price_id [String, nil] The external price id of the price to add to the subscription. + # + # @param fixed_price_quantity [Float, nil] The new quantity of the price, if the price is a fixed price. + # + # @param maximum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for + # ... + # + # @param minimum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for + # ... + # + # @param price [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice, nil] The definition of a new price to create and add to the subscription. + # + # @param price_id [String, nil] The id of the price to add to the subscription. # @see Orb::Models::SubscriptionCreateParams::ReplacePrice#allocation_price class AllocationPrice < Orb::Internal::Type::BaseModel @@ -8125,17 +7810,22 @@ class AllocationPrice < Orb::Internal::Type::BaseModel # @return [Boolean] required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean - # @!parse - # # The definition of a new allocation price to create and add to the subscription. - # # - # # @param amount [String] - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice::Cadence] - # # @param currency [String] - # # @param expires_at_end_of_cadence [Boolean] - # # - # def initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice} for more + # details. + # + # The definition of a new allocation price to create and add to the subscription. + # + # @param amount [String] An amount of the currency to allocate to the customer at the specified cadence. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice::Cadence] The cadence at which to allocate the amount to the customer. + # + # @param currency [String] An ISO 4217 currency string or a custom pricing unit identifier in which to bill + # ... + # + # @param expires_at_end_of_cadence [Boolean] Whether the allocated amount should expire at the end of the cadence or roll ove + # ... # The cadence at which to allocate the amount to the customer. # @@ -8150,11 +7840,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -8185,15 +7872,20 @@ class Discount < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :usage_discount, Float, nil?: true - # @!parse - # # @param discount_type [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Discount::DiscountType] - # # @param amount_discount [String, nil] - # # @param percentage_discount [Float, nil] - # # @param usage_discount [Float, nil] - # # - # def initialize(discount_type:, amount_discount: nil, percentage_discount: nil, usage_discount: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(discount_type:, amount_discount: nil, percentage_discount: nil, usage_discount: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Discount} for more + # details. + # + # @param discount_type [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Discount::DiscountType] + # + # @param amount_discount [String, nil] Only available if discount_type is `amount`. + # + # @param percentage_discount [Float, nil] Only available if discount_type is `percentage`. This is a number between 0 and + # ... + # + # @param usage_discount [Float, nil] Only available if discount_type is `usage`. Number of usage units that this disc + # ... # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Discount#discount_type module DiscountType @@ -8203,11 +7895,8 @@ module DiscountType USAGE = :usage AMOUNT = :amount - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -8401,47 +8090,50 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::UnitConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :unit] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :unit, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :unit) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::UnitConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :unit] # The cadence to bill for this price on. # @@ -8456,11 +8148,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice#unit_config @@ -8471,12 +8160,8 @@ class UnitConfig < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param unit_amount [String] - # # - # def initialize(unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:) + # @param unit_amount [String] Rate per unit of usage end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice#billing_cycle_configuration @@ -8494,16 +8179,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -8514,11 +8196,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -8537,16 +8216,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -8557,11 +8233,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -8676,47 +8349,50 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param package_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::PackageConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :package] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # package_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param package_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::PackageConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :package] # The cadence to bill for this price on. # @@ -8731,11 +8407,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice#package_config @@ -8753,13 +8426,15 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @return [Integer] required :package_size, Integer - # @!parse - # # @param package_amount [String] - # # @param package_size [Integer] - # # - # def initialize(package_amount:, package_size:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(package_amount:, package_size:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::PackageConfig} + # for more details. + # + # @param package_amount [String] A currency amount to rate usage by + # + # @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide + # ... end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice#billing_cycle_configuration @@ -8777,16 +8452,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -8797,11 +8469,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -8820,16 +8489,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -8840,11 +8506,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -8959,47 +8622,50 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence] - # # @param item_id [String] - # # @param matrix_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :matrix] - # # - # def initialize( - # cadence:, - # item_id:, - # matrix_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :matrix, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, matrix_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :matrix) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param matrix_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :matrix] # The cadence to bill for this price on. # @@ -9014,11 +8680,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice#matrix_config @@ -9046,14 +8709,12 @@ class MatrixConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param default_unit_amount [String] - # # @param dimensions [Array] - # # @param matrix_values [Array] - # # - # def initialize(default_unit_amount:, dimensions:, matrix_values:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(default_unit_amount:, dimensions:, matrix_values:) + # @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value + # + # @param dimensions [Array] One or two event property values to evaluate matrix groups by + # + # @param matrix_values [Array] Matrix values for specified matrix grouping keys class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values @@ -9070,13 +8731,15 @@ class MatrixValue < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param dimension_values [Array] - # # @param unit_amount [String] - # # - # def initialize(dimension_values:, unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, unit_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue} + # for more details. + # + # @param dimension_values [Array] One or two matrix keys to filter usage to this Matrix value by. For example, ["r + # ... + # + # @param unit_amount [String] Unit price for the specified dimension_values end end @@ -9095,16 +8758,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -9115,11 +8775,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -9138,16 +8795,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -9158,11 +8812,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -9277,47 +8928,50 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered] # The cadence to bill for this price on. # @@ -9332,11 +8986,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice#tiered_config @@ -9348,12 +8999,8 @@ class TieredConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Tiers for rating based on total usage quantities into the specified tier class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit @@ -9374,14 +9021,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :last_unit, Float, nil?: true - # @!parse - # # @param first_unit [Float] - # # @param unit_amount [String] - # # @param last_unit [Float, nil] - # # - # def initialize(first_unit:, unit_amount:, last_unit: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(first_unit:, unit_amount:, last_unit: nil) + # @param first_unit [Float] Exclusive tier starting value + # + # @param unit_amount [String] Amount per unit + # + # @param last_unit [Float, nil] Inclusive tier ending value. If null, this is treated as the last tier end end @@ -9400,16 +9045,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -9420,11 +9062,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -9443,16 +9082,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -9463,11 +9099,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -9582,47 +9215,50 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_bps_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_bps] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_bps_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_bps_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_bps] # The cadence to bill for this price on. # @@ -9637,11 +9273,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice#tiered_bps_config @@ -9658,12 +9291,13 @@ class TieredBpsConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig} + # for more details. + # + # @param tiers [Array] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -9690,15 +9324,14 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param minimum_amount [String] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Per-event basis point rate + # + # @param minimum_amount [String] Exclusive tier starting value + # + # @param maximum_amount [String, nil] Inclusive tier ending value + # + # @param per_unit_maximum [String, nil] Per unit maximum to charge end end @@ -9717,16 +9350,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -9737,11 +9367,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -9760,16 +9387,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -9780,11 +9404,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -9899,47 +9520,50 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bps_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BpsConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bps] - # # - # def initialize( - # bps_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice} + # for more details. + # + # @param bps_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BpsConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bps] # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice#bps_config class BpsConfig < Orb::Internal::Type::BaseModel @@ -9955,13 +9579,10 @@ class BpsConfig < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, per_unit_maximum: nil) + # @param bps [Float] Basis point take rate per event + # + # @param per_unit_maximum [String, nil] Optional currency amount maximum to cap spend per event end # The cadence to bill for this price on. @@ -9977,11 +9598,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice#billing_cycle_configuration @@ -9999,16 +9617,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10019,11 +9634,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -10042,16 +9654,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10062,11 +9671,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -10181,47 +9787,50 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bulk_bps_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bulk_bps] - # # - # def initialize( - # bulk_bps_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bulk_bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bulk_bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice} + # for more details. + # + # @param bulk_bps_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bulk_bps] # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice#bulk_bps_config class BulkBpsConfig < Orb::Internal::Type::BaseModel @@ -10237,12 +9846,13 @@ class BulkBpsConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig} + # for more details. + # + # @param tiers [Array] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -10263,14 +9873,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Basis points to rate on + # + # @param maximum_amount [String, nil] Upper bound for tier + # + # @param per_unit_maximum [String, nil] The maximum amount to charge for any one event end end @@ -10287,11 +9895,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice#billing_cycle_configuration @@ -10309,16 +9914,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10329,11 +9931,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -10352,16 +9951,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10372,11 +9968,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -10491,47 +10084,50 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bulk_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bulk] - # # - # def initialize( - # bulk_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bulk, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bulk) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice} + # for more details. + # + # @param bulk_config [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bulk] # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice#bulk_config class BulkConfig < Orb::Internal::Type::BaseModel @@ -10542,12 +10138,8 @@ class BulkConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Bulk tiers for rating based on total usage volume class Tier < Orb::Internal::Type::BaseModel # @!attribute unit_amount @@ -10562,13 +10154,10 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :maximum_units, Float, nil?: true - # @!parse - # # @param unit_amount [String] - # # @param maximum_units [Float, nil] - # # - # def initialize(unit_amount:, maximum_units: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:, maximum_units: nil) + # @param unit_amount [String] Amount per unit + # + # @param maximum_units [Float, nil] Upper bound for this tier end end @@ -10585,11 +10174,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice#billing_cycle_configuration @@ -10607,16 +10193,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10627,11 +10210,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -10650,16 +10230,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10670,11 +10247,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -10788,47 +10362,50 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param threshold_total_amount_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :threshold_total_amount] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # threshold_total_amount_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :threshold_total_amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, threshold_total_amount_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :threshold_total_amount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param threshold_total_amount_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :threshold_total_amount] # The cadence to bill for this price on. # @@ -10843,11 +10420,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice#billing_cycle_configuration @@ -10865,16 +10439,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10885,11 +10456,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -10908,16 +10476,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10928,11 +10493,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -11046,47 +10608,50 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_package_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_package] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_package_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_package_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_package] # The cadence to bill for this price on. # @@ -11101,11 +10666,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice#billing_cycle_configuration @@ -11123,16 +10685,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11143,11 +10702,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -11166,16 +10722,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11186,11 +10739,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -11304,47 +10854,50 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_with_minimum_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_with_minimum] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_with_minimum_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_with_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_with_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_with_minimum_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_with_minimum] # The cadence to bill for this price on. # @@ -11359,11 +10912,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice#billing_cycle_configuration @@ -11381,16 +10931,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11401,11 +10948,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -11424,16 +10968,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11444,11 +10985,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -11562,47 +11100,50 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_with_percent_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :unit_with_percent] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_with_percent_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :unit_with_percent, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :unit_with_percent) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_with_percent_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :unit_with_percent] # The cadence to bill for this price on. # @@ -11617,11 +11158,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice#billing_cycle_configuration @@ -11639,16 +11177,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11659,11 +11194,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -11682,16 +11214,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11702,11 +11231,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -11821,47 +11347,50 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param package_with_allocation_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :package_with_allocation] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # package_with_allocation_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :package_with_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, package_with_allocation_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :package_with_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param package_with_allocation_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :package_with_allocation] # The cadence to bill for this price on. # @@ -11876,11 +11405,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice#billing_cycle_configuration @@ -11898,16 +11424,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11918,11 +11441,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -11941,16 +11461,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11961,11 +11478,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -12079,47 +11593,50 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_with_proration_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_with_proration] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_with_proration_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_with_proration_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_with_proration] # The cadence to bill for this price on. # @@ -12134,11 +11651,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice#billing_cycle_configuration @@ -12156,16 +11670,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12176,11 +11687,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -12199,16 +11707,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12219,11 +11724,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -12337,47 +11839,50 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_with_proration_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :unit_with_proration] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_with_proration_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :unit_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :unit_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_with_proration_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :unit_with_proration] # The cadence to bill for this price on. # @@ -12392,11 +11897,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice#billing_cycle_configuration @@ -12414,16 +11916,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12434,11 +11933,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -12457,16 +11953,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12477,11 +11970,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -12595,47 +12085,50 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence] - # # @param grouped_allocation_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_allocation] - # # - # def initialize( - # cadence:, - # grouped_allocation_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_allocation_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_allocation_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_allocation] # The cadence to bill for this price on. # @@ -12650,11 +12143,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice#billing_cycle_configuration @@ -12672,16 +12162,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12692,11 +12179,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -12715,16 +12199,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12735,11 +12216,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -12854,47 +12332,50 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence] - # # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_with_prorated_minimum] - # # - # def initialize( - # cadence:, - # grouped_with_prorated_minimum_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_with_prorated_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_with_prorated_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_with_prorated_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_with_prorated_minimum] # The cadence to bill for this price on. # @@ -12909,11 +12390,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#billing_cycle_configuration @@ -12931,16 +12409,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12951,11 +12426,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -12974,16 +12446,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12994,11 +12463,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -13112,47 +12578,50 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bulk_with_proration_config [Hash{Symbol=>Object}] - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bulk_with_proration] - # # - # def initialize( - # bulk_with_proration_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bulk_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_with_proration_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bulk_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice} + # for more details. + # + # @param bulk_with_proration_config [Hash{Symbol=>Object}] + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bulk_with_proration] # The cadence to bill for this price on. # @@ -13167,11 +12636,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice#billing_cycle_configuration @@ -13189,16 +12655,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -13209,11 +12672,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -13232,16 +12692,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -13252,11 +12709,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -13371,47 +12825,50 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :scalable_matrix_with_unit_pricing] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # scalable_matrix_with_unit_pricing_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :scalable_matrix_with_unit_pricing, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_unit_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_unit_pricing) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :scalable_matrix_with_unit_pricing] # The cadence to bill for this price on. # @@ -13426,11 +12883,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#billing_cycle_configuration @@ -13448,16 +12902,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -13468,11 +12919,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -13491,16 +12939,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -13511,11 +12956,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -13630,47 +13072,50 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :scalable_matrix_with_tiered_pricing] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # scalable_matrix_with_tiered_pricing_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :scalable_matrix_with_tiered_pricing, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_tiered_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_tiered_pricing) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :scalable_matrix_with_tiered_pricing] # The cadence to bill for this price on. # @@ -13685,11 +13130,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#billing_cycle_configuration @@ -13707,16 +13149,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -13727,11 +13166,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -13750,16 +13186,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -13770,11 +13203,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -13889,47 +13319,50 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence] - # # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :cumulative_grouped_bulk] - # # - # def initialize( - # cadence:, - # cumulative_grouped_bulk_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :cumulative_grouped_bulk, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, cumulative_grouped_bulk_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :cumulative_grouped_bulk) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence] The cadence to bill for this price on. + # + # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :cumulative_grouped_bulk] # The cadence to bill for this price on. # @@ -13944,11 +13377,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#billing_cycle_configuration @@ -13966,16 +13396,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -13986,11 +13413,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -14009,16 +13433,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14029,11 +13450,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -14148,47 +13566,50 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence] - # # @param item_id [String] - # # @param max_group_tiered_package_config [Hash{Symbol=>Object}] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :max_group_tiered_package] - # # - # def initialize( - # cadence:, - # item_id:, - # max_group_tiered_package_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :max_group_tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, max_group_tiered_package_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :max_group_tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param max_group_tiered_package_config [Hash{Symbol=>Object}] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :max_group_tiered_package] # The cadence to bill for this price on. # @@ -14203,11 +13624,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#billing_cycle_configuration @@ -14225,16 +13643,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14245,11 +13660,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -14268,16 +13680,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14288,11 +13697,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -14407,47 +13813,50 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence] - # # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_with_metered_minimum] - # # - # def initialize( - # cadence:, - # grouped_with_metered_minimum_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_with_metered_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_with_metered_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_with_metered_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_with_metered_minimum] # The cadence to bill for this price on. # @@ -14462,11 +13871,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#billing_cycle_configuration @@ -14484,16 +13890,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14504,11 +13907,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -14527,16 +13927,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14547,11 +13944,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -14666,47 +14060,50 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence] - # # @param item_id [String] - # # @param matrix_with_display_name_config [Hash{Symbol=>Object}] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :matrix_with_display_name] - # # - # def initialize( - # cadence:, - # item_id:, - # matrix_with_display_name_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :matrix_with_display_name, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, matrix_with_display_name_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :matrix_with_display_name) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param matrix_with_display_name_config [Hash{Symbol=>Object}] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :matrix_with_display_name] # The cadence to bill for this price on. # @@ -14721,11 +14118,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#billing_cycle_configuration @@ -14743,16 +14137,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14763,11 +14154,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -14786,16 +14174,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14806,11 +14191,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -14924,47 +14306,50 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence] - # # @param grouped_tiered_package_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_tiered_package] - # # - # def initialize( - # cadence:, - # grouped_tiered_package_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_tiered_package_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_tiered_package_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_tiered_package] # The cadence to bill for this price on. # @@ -14979,11 +14364,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice#billing_cycle_configuration @@ -15001,16 +14383,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -15021,11 +14400,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -15044,16 +14420,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -15064,18 +14437,14 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end - # @!parse - # # @return [Array(Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice)] end end end diff --git a/lib/orb/models/subscription_create_response.rb b/lib/orb/models/subscription_create_response.rb index 31036f2a..b153dd59 100644 --- a/lib/orb/models/subscription_create_response.rb +++ b/lib/orb/models/subscription_create_response.rb @@ -207,69 +207,75 @@ class SubscriptionCreateResponse < Orb::Internal::Type::BaseModel # @return [Orb::Models::SubscriptionCreateResponse::ChangedResources, nil] optional :changed_resources, -> { Orb::Models::SubscriptionCreateResponse::ChangedResources }, nil?: true - # @!parse - # # @param id [String] - # # @param active_plan_phase_order [Integer, nil] - # # @param adjustment_intervals [Array] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionCreateResponse::BillingCycleAnchorConfiguration] - # # @param billing_cycle_day [Integer] - # # @param created_at [Time] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param customer [Orb::Models::Customer] - # # @param default_invoice_memo [String, nil] - # # @param discount_intervals [Array] - # # @param end_date [Time, nil] - # # @param fixed_fee_quantity_schedule [Array] - # # @param invoicing_threshold [String, nil] - # # @param maximum_intervals [Array] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum_intervals [Array] - # # @param net_terms [Integer] - # # @param pending_subscription_change [Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange, nil] - # # @param plan [Orb::Models::Plan] - # # @param price_intervals [Array] - # # @param redeemed_coupon [Orb::Models::SubscriptionCreateResponse::RedeemedCoupon, nil] - # # @param start_date [Time] - # # @param status [Symbol, Orb::Models::SubscriptionCreateResponse::Status] - # # @param trial_info [Orb::Models::SubscriptionCreateResponse::TrialInfo] - # # @param changed_resources [Orb::Models::SubscriptionCreateResponse::ChangedResources, nil] - # # - # def initialize( - # id:, - # active_plan_phase_order:, - # adjustment_intervals:, - # auto_collection:, - # billing_cycle_anchor_configuration:, - # billing_cycle_day:, - # created_at:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # customer:, - # default_invoice_memo:, - # discount_intervals:, - # end_date:, - # fixed_fee_quantity_schedule:, - # invoicing_threshold:, - # maximum_intervals:, - # metadata:, - # minimum_intervals:, - # net_terms:, - # pending_subscription_change:, - # plan:, - # price_intervals:, - # redeemed_coupon:, - # start_date:, - # status:, - # trial_info:, - # changed_resources: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateResponse} for more details. + # + # @param id [String] + # + # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase + # ... + # + # @param adjustment_intervals [Array] The adjustment intervals for this subscription sorted by the start_date of the a + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionCreateResponse::BillingCycleAnchorConfiguration] + # + # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param created_at [Time] + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i + # ... + # + # @param discount_intervals [Array] The discount intervals for this subscription sorted by the start_date. + # + # @param end_date [Time, nil] The date Orb stops billing for this subscription. + # + # @param fixed_fee_quantity_schedule [Array] + # + # @param invoicing_threshold [String, nil] + # + # @param maximum_intervals [Array] The maximum intervals for this subscription sorted by the start_date. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum_intervals [Array] The minimum intervals for this subscription sorted by the start_date. + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param pending_subscription_change [Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription. + # + # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # ... + # + # @param price_intervals [Array] The price intervals for this subscription. + # + # @param redeemed_coupon [Orb::Models::SubscriptionCreateResponse::RedeemedCoupon, nil] + # + # @param start_date [Time] The date Orb starts billing for this subscription. + # + # @param status [Symbol, Orb::Models::SubscriptionCreateResponse::Status] + # + # @param trial_info [Orb::Models::SubscriptionCreateResponse::TrialInfo] + # + # @param changed_resources [Orb::Models::SubscriptionCreateResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet + # ... class AdjustmentInterval < Orb::Internal::Type::BaseModel # @!attribute id @@ -301,16 +307,16 @@ class AdjustmentInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param id [String] - # # @param adjustment [Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) + # @param id [String] + # + # @param adjustment [Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # + # @param applies_to_price_interval_ids [Array] The price interval IDs that this adjustment applies to. + # + # @param end_date [Time, nil] The end date of the adjustment interval. + # + # @param start_date [Time] The start date of the adjustment interval. # @see Orb::Models::SubscriptionCreateResponse::AdjustmentInterval#adjustment module Adjustment @@ -376,29 +382,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -444,29 +447,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -512,29 +512,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -586,31 +583,28 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -656,34 +650,30 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] end end @@ -713,14 +703,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateResponse::BillingCycleAnchorConfiguration} for + # more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end module DiscountInterval @@ -771,27 +766,18 @@ class AmountDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param discount_type [Symbol, :amount] - # # - # def initialize( - # amount_discount:, - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # discount_type: :amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount) + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -831,27 +817,23 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param percentage_discount [Float] - # # @param start_date [Time] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # percentage_discount:, - # start_date:, - # discount_type: :percentage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1 + # ... + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -891,32 +873,27 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # usage_discount:, - # discount_type: :usage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval)] end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -940,15 +917,11 @@ class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param end_date [Time, nil] - # # @param price_id [String] - # # @param quantity [Float] - # # @param start_date [Time] - # # - # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, price_id:, quantity:, start_date:) + # @param end_date [Time, nil] + # @param price_id [String] + # @param quantity [Float] + # @param start_date [Time] end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -983,16 +956,20 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param maximum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateResponse::MaximumInterval} for more details. + # + # @param applies_to_price_ids [Array] The price ids that this maximum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this maximum interval applies to. + # + # @param end_date [Time, nil] The end date of the maximum interval. + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the maximum interval. end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1027,16 +1004,20 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param minimum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateResponse::MinimumInterval} for more details. + # + # @param applies_to_price_ids [Array] The price ids that this minimum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this minimum interval applies to. + # + # @param end_date [Time, nil] The end date of the minimum interval. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the minimum interval. end # @see Orb::Models::SubscriptionCreateResponse#pending_subscription_change @@ -1046,14 +1027,10 @@ class PendingSubscriptionChange < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # A pending subscription change if one exists on this subscription. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # A pending subscription change if one exists on this subscription. + # + # @param id [String] end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1135,39 +1112,40 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. - # # - # # @param id [String] - # # @param billing_cycle_day [Integer] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param end_date [Time, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param start_date [Time] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # billing_cycle_day:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # end_date:, - # filter:, - # fixed_fee_quantity_transitions:, - # price:, - # start_date:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateResponse::PriceInterval} for more details. + # + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + # + # @param id [String] + # + # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. + # + # @param fixed_fee_quantity_transitions [Array, nil] The fixed fee quantity transitions for this price interval. This is only relevan + # ... + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @!attribute effective_date @@ -1185,14 +1163,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param price_id [String] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, price_id:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, price_id:, quantity:) + # @param effective_date [Time] + # @param price_id [String] + # @param quantity [Integer] end end @@ -1213,14 +1187,10 @@ class RedeemedCoupon < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param coupon_id [String] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(coupon_id:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(coupon_id:, end_date:, start_date:) + # @param coupon_id [String] + # @param end_date [Time, nil] + # @param start_date [Time] end # @see Orb::Models::SubscriptionCreateResponse#status @@ -1231,11 +1201,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionCreateResponse#trial_info @@ -1245,12 +1212,8 @@ class TrialInfo < Orb::Internal::Type::BaseModel # @return [Time, nil] required :end_date, Time, nil?: true - # @!parse - # # @param end_date [Time, nil] - # # - # def initialize(end_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:) + # @param end_date [Time, nil] end # @see Orb::Models::SubscriptionCreateResponse#changed_resources @@ -1279,19 +1242,18 @@ class ChangedResources < Orb::Internal::Type::BaseModel # @return [Array] required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } - # @!parse - # # The resources that were changed as part of this operation. Only present when - # # fetched through the subscription changes API or if the - # # `include_changed_resources` parameter was passed in the request. - # # - # # @param created_credit_notes [Array] - # # @param created_invoices [Array] - # # @param voided_credit_notes [Array] - # # @param voided_invoices [Array] - # # - # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:) + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @param created_credit_notes [Array] The credit notes that were created as part of this operation. + # + # @param created_invoices [Array] The invoices that were created as part of this operation. + # + # @param voided_credit_notes [Array] The credit notes that were voided as part of this operation. + # + # @param voided_invoices [Array] The invoices that were voided as part of this operation. end end end diff --git a/lib/orb/models/subscription_fetch_costs_params.rb b/lib/orb/models/subscription_fetch_costs_params.rb index fa38577c..9a6d01f9 100644 --- a/lib/orb/models/subscription_fetch_costs_params.rb +++ b/lib/orb/models/subscription_fetch_costs_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Subscriptions#fetch_costs class SubscriptionFetchCostsParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute currency @@ -35,16 +34,20 @@ class SubscriptionFetchCostsParams < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode, nil] optional :view_mode, enum: -> { Orb::Models::SubscriptionFetchCostsParams::ViewMode }, nil?: true - # @!parse - # # @param currency [String, nil] - # # @param timeframe_end [Time, nil] - # # @param timeframe_start [Time, nil] - # # @param view_mode [Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionFetchCostsParams} for more details. + # + # @param currency [String, nil] The currency or custom pricing unit to use. + # + # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`. + # + # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`. + # + # @param view_mode [Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] # Controls whether Orb returns cumulative costs since the start of the billing # period, or incremental day-by-day costs. If your customer has minimums or @@ -56,11 +59,8 @@ module ViewMode PERIODIC = :periodic CUMULATIVE = :cumulative - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/subscription_fetch_costs_response.rb b/lib/orb/models/subscription_fetch_costs_response.rb index 0e8169aa..bc3feae1 100644 --- a/lib/orb/models/subscription_fetch_costs_response.rb +++ b/lib/orb/models/subscription_fetch_costs_response.rb @@ -9,12 +9,8 @@ class SubscriptionFetchCostsResponse < Orb::Internal::Type::BaseModel # @return [Array] required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionFetchCostsResponse::Data] } - # @!parse - # # @param data [Array] - # # - # def initialize(data:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(data:) + # @param data [Array] class Data < Orb::Internal::Type::BaseModel # @!attribute per_price_costs @@ -45,16 +41,16 @@ class Data < Orb::Internal::Type::BaseModel # @return [String] required :total, String - # @!parse - # # @param per_price_costs [Array] - # # @param subtotal [String] - # # @param timeframe_end [Time] - # # @param timeframe_start [Time] - # # @param total [String] - # # - # def initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:) + # @param per_price_costs [Array] + # + # @param subtotal [String] Total costs for the timeframe, excluding any minimums and discounts. + # + # @param timeframe_end [Time] + # + # @param timeframe_start [Time] + # + # @param total [String] Total costs for the timeframe, including any minimums and discounts. class PerPriceCost < Orb::Internal::Type::BaseModel # @!attribute price @@ -87,16 +83,16 @@ class PerPriceCost < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :quantity, Float, nil?: true - # @!parse - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param price_id [String] - # # @param subtotal [String] - # # @param total [String] - # # @param quantity [Float, nil] - # # - # def initialize(price:, price_id:, subtotal:, total:, quantity: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(price:, price_id:, subtotal:, total:, quantity: nil) + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The price object + # + # @param price_id [String] The price the cost is associated with + # + # @param subtotal [String] Price's contributions for the timeframe, excluding any minimums and discounts. + # + # @param total [String] Price's contributions for the timeframe, including minimums and discounts. + # + # @param quantity [Float, nil] The price's quantity for the timeframe end end end diff --git a/lib/orb/models/subscription_fetch_params.rb b/lib/orb/models/subscription_fetch_params.rb index b8a0b3fc..060f4802 100644 --- a/lib/orb/models/subscription_fetch_params.rb +++ b/lib/orb/models/subscription_fetch_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Subscriptions#fetch class SubscriptionFetchParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/subscription_fetch_schedule_params.rb b/lib/orb/models/subscription_fetch_schedule_params.rb index 68acd23d..349565ec 100644 --- a/lib/orb/models/subscription_fetch_schedule_params.rb +++ b/lib/orb/models/subscription_fetch_schedule_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Subscriptions#fetch_schedule class SubscriptionFetchScheduleParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute cursor @@ -15,16 +14,12 @@ class SubscriptionFetchScheduleParams < Orb::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - # @!attribute start_date_gt # # @return [Time, nil] @@ -45,29 +40,24 @@ class SubscriptionFetchScheduleParams < Orb::Internal::Type::BaseModel # @return [Time, nil] optional :start_date_lte, Time, nil?: true - # @!parse - # # @param cursor [String, nil] - # # @param limit [Integer] - # # @param start_date_gt [Time, nil] - # # @param start_date_gte [Time, nil] - # # @param start_date_lt [Time, nil] - # # @param start_date_lte [Time, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # cursor: nil, - # limit: nil, - # start_date_gt: nil, - # start_date_gte: nil, - # start_date_lt: nil, - # start_date_lte: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, limit: nil, start_date_gt: nil, start_date_gte: nil, start_date_lt: nil, start_date_lte: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionFetchScheduleParams} for more details. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param start_date_gt [Time, nil] + # + # @param start_date_gte [Time, nil] + # + # @param start_date_lt [Time, nil] + # + # @param start_date_lte [Time, nil] + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/subscription_fetch_schedule_response.rb b/lib/orb/models/subscription_fetch_schedule_response.rb index ecd1cb8e..ff7245e0 100644 --- a/lib/orb/models/subscription_fetch_schedule_response.rb +++ b/lib/orb/models/subscription_fetch_schedule_response.rb @@ -24,15 +24,11 @@ class SubscriptionFetchScheduleResponse < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param created_at [Time] - # # @param end_date [Time, nil] - # # @param plan [Orb::Models::SubscriptionFetchScheduleResponse::Plan] - # # @param start_date [Time] - # # - # def initialize(created_at:, end_date:, plan:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_at:, end_date:, plan:, start_date:) + # @param created_at [Time] + # @param end_date [Time, nil] + # @param plan [Orb::Models::SubscriptionFetchScheduleResponse::Plan] + # @param start_date [Time] # @see Orb::Models::SubscriptionFetchScheduleResponse#plan class Plan < Orb::Internal::Type::BaseModel @@ -54,14 +50,16 @@ class Plan < Orb::Internal::Type::BaseModel # @return [String, nil] required :name, String, nil?: true - # @!parse - # # @param id [String, nil] - # # @param external_plan_id [String, nil] - # # @param name [String, nil] - # # - # def initialize(id:, external_plan_id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, external_plan_id:, name:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionFetchScheduleResponse::Plan} for more details. + # + # @param id [String, nil] + # + # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a + # ... + # + # @param name [String, nil] end end end diff --git a/lib/orb/models/subscription_fetch_usage_params.rb b/lib/orb/models/subscription_fetch_usage_params.rb index 66ceb58d..bdbd598c 100644 --- a/lib/orb/models/subscription_fetch_usage_params.rb +++ b/lib/orb/models/subscription_fetch_usage_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Subscriptions#fetch_usage class SubscriptionFetchUsageParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute billable_metric_id @@ -69,37 +68,33 @@ class SubscriptionFetchUsageParams < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode, nil] optional :view_mode, enum: -> { Orb::Models::SubscriptionFetchUsageParams::ViewMode }, nil?: true - # @!parse - # # @param billable_metric_id [String, nil] - # # @param first_dimension_key [String, nil] - # # @param first_dimension_value [String, nil] - # # @param granularity [Symbol, Orb::Models::SubscriptionFetchUsageParams::Granularity, nil] - # # @param group_by [String, nil] - # # @param second_dimension_key [String, nil] - # # @param second_dimension_value [String, nil] - # # @param timeframe_end [Time, nil] - # # @param timeframe_start [Time, nil] - # # @param view_mode [Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # billable_metric_id: nil, - # first_dimension_key: nil, - # first_dimension_value: nil, - # granularity: nil, - # group_by: nil, - # second_dimension_key: nil, - # second_dimension_value: nil, - # timeframe_end: nil, - # timeframe_start: nil, - # view_mode: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(billable_metric_id: nil, first_dimension_key: nil, first_dimension_value: nil, granularity: nil, group_by: nil, second_dimension_key: nil, second_dimension_value: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionFetchUsageParams} for more details. + # + # @param billable_metric_id [String, nil] When specified in conjunction with `group_by`, this parameter filters usage to a + # ... + # + # @param first_dimension_key [String, nil] + # + # @param first_dimension_value [String, nil] + # + # @param granularity [Symbol, Orb::Models::SubscriptionFetchUsageParams::Granularity, nil] This determines the windowing of usage reporting. + # + # @param group_by [String, nil] Groups per-price usage by the key provided. + # + # @param second_dimension_key [String, nil] + # + # @param second_dimension_value [String, nil] + # + # @param timeframe_end [Time, nil] Usage returned is exclusive of `timeframe_end`. + # + # @param timeframe_start [Time, nil] Usage returned is inclusive of `timeframe_start`. + # + # @param view_mode [Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode, nil] Controls whether Orb returns cumulative usage since the start of the billing per + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] # This determines the windowing of usage reporting. module Granularity @@ -107,11 +102,8 @@ module Granularity DAY = :day - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Controls whether Orb returns cumulative usage since the start of the billing @@ -124,11 +116,8 @@ module ViewMode PERIODIC = :periodic CUMULATIVE = :cumulative - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/subscription_list_params.rb b/lib/orb/models/subscription_list_params.rb index de1241b9..7ffe6c73 100644 --- a/lib/orb/models/subscription_list_params.rb +++ b/lib/orb/models/subscription_list_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Subscriptions#list class SubscriptionListParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute created_at_gt @@ -45,50 +44,41 @@ class SubscriptionListParams < Orb::Internal::Type::BaseModel # @return [Array, nil] optional :external_customer_id, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!attribute [r] limit + # @!attribute limit # The number of items to fetch. Defaults to 20. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - # @!attribute status # # @return [Symbol, Orb::Models::SubscriptionListParams::Status, nil] optional :status, enum: -> { Orb::Models::SubscriptionListParams::Status }, nil?: true - # @!parse - # # @param created_at_gt [Time, nil] - # # @param created_at_gte [Time, nil] - # # @param created_at_lt [Time, nil] - # # @param created_at_lte [Time, nil] - # # @param cursor [String, nil] - # # @param customer_id [Array, nil] - # # @param external_customer_id [Array, nil] - # # @param limit [Integer] - # # @param status [Symbol, Orb::Models::SubscriptionListParams::Status, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # created_at_gt: nil, - # created_at_gte: nil, - # created_at_lt: nil, - # created_at_lte: nil, - # cursor: nil, - # customer_id: nil, - # external_customer_id: nil, - # limit: nil, - # status: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, status: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionListParams} for more details. + # + # @param created_at_gt [Time, nil] + # + # @param created_at_gte [Time, nil] + # + # @param created_at_lt [Time, nil] + # + # @param created_at_lte [Time, nil] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param customer_id [Array, nil] + # + # @param external_customer_id [Array, nil] + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param status [Symbol, Orb::Models::SubscriptionListParams::Status, nil] + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] module Status extend Orb::Internal::Type::Enum @@ -97,11 +87,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/subscription_price_intervals_params.rb b/lib/orb/models/subscription_price_intervals_params.rb index a9be5318..6101657e 100644 --- a/lib/orb/models/subscription_price_intervals_params.rb +++ b/lib/orb/models/subscription_price_intervals_params.rb @@ -4,31 +4,22 @@ module Orb module Models # @see Orb::Resources::Subscriptions#price_intervals class SubscriptionPriceIntervalsParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!attribute [r] add + # @!attribute add # A list of price intervals to add to the subscription. # # @return [Array, nil] optional :add, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionPriceIntervalsParams::Add] } - # @!parse - # # @return [Array] - # attr_writer :add - - # @!attribute [r] add_adjustments + # @!attribute add_adjustments # A list of adjustments to add to the subscription. # # @return [Array, nil] optional :add_adjustments, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment] } - # @!parse - # # @return [Array] - # attr_writer :add_adjustments - # @!attribute allow_invoice_credit_or_void # If false, this request will fail if it would void an issued invoice or create a # credit note. Consider using this as a safety mechanism if you do not expect @@ -37,48 +28,35 @@ class SubscriptionPriceIntervalsParams < Orb::Internal::Type::BaseModel # @return [Boolean, nil] optional :allow_invoice_credit_or_void, Orb::Internal::Type::Boolean, nil?: true - # @!attribute [r] edit + # @!attribute edit # A list of price intervals to edit on the subscription. # # @return [Array, nil] optional :edit, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionPriceIntervalsParams::Edit] } - # @!parse - # # @return [Array] - # attr_writer :edit - - # @!attribute [r] edit_adjustments + # @!attribute edit_adjustments # A list of adjustments to edit on the subscription. # # @return [Array, nil] optional :edit_adjustments, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment] } - # @!parse - # # @return [Array] - # attr_writer :edit_adjustments - - # @!parse - # # @param add [Array] - # # @param add_adjustments [Array] - # # @param allow_invoice_credit_or_void [Boolean, nil] - # # @param edit [Array] - # # @param edit_adjustments [Array] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # add: nil, - # add_adjustments: nil, - # allow_invoice_credit_or_void: nil, - # edit: nil, - # edit_adjustments: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(add: nil, add_adjustments: nil, allow_invoice_credit_or_void: nil, edit: nil, edit_adjustments: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams} for more details. + # + # @param add [Array] A list of price intervals to add to the subscription. + # + # @param add_adjustments [Array] A list of adjustments to add to the subscription. + # + # @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a + # ... + # + # @param edit [Array] A list of price intervals to edit on the subscription. + # + # @param edit_adjustments [Array] A list of adjustments to edit on the subscription. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] class Add < Orb::Internal::Type::BaseModel # @!attribute start_date @@ -171,39 +149,39 @@ class Add < Orb::Internal::Type::BaseModel # @return [Array, nil] optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] - # # @param allocation_price [Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice, nil] - # # @param discounts [Array, nil] - # # @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] - # # @param external_price_id [String, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param maximum_amount [Float, nil] - # # @param minimum_amount [Float, nil] - # # @param price [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice, nil] - # # @param price_id [String, nil] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # start_date:, - # allocation_price: nil, - # discounts: nil, - # end_date: nil, - # external_price_id: nil, - # filter: nil, - # fixed_fee_quantity_transitions: nil, - # maximum_amount: nil, - # minimum_amount: nil, - # price: nil, - # price_id: nil, - # usage_customer_ids: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(start_date:, allocation_price: nil, discounts: nil, end_date: nil, external_price_id: nil, filter: nil, fixed_fee_quantity_transitions: nil, maximum_amount: nil, minimum_amount: nil, price: nil, price_id: nil, usage_customer_ids: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add} for more details. + # + # @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The start date of the price interval. This is the date that the price will start + # ... + # + # @param allocation_price [Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice, nil] The definition of a new allocation price to create and add to the subscription. + # + # @param discounts [Array, nil] A list of discounts to initialize on the price interval. + # + # @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The end date of the price interval. This is the date that the price will stop bi + # ... + # + # @param external_price_id [String, nil] The external price id of the price to add to the subscription. + # + # @param filter [String, nil] An additional filter to apply to usage queries. This filter must be expressed as + # ... + # + # @param fixed_fee_quantity_transitions [Array, nil] A list of fixed fee quantity transitions to initialize on the price interval. + # + # @param maximum_amount [Float, nil] The maximum amount that will be billed for this price interval for a given billi + # ... + # + # @param minimum_amount [Float, nil] The minimum amount that will be billed for this price interval for a given billi + # ... + # + # @param price [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice, nil] The definition of a new price to create and add to the subscription. + # + # @param price_id [String, nil] The id of the price to add to the subscription. + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... # The start date of the price interval. This is the date that the price will start # billing on the subscription. @@ -216,9 +194,8 @@ module StartDate variant enum: -> { Orb::Models::BillingCycleRelativeDate } - # @!parse - # # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] - # def self.variants; end + # @!method self.variants + # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add#allocation_price @@ -250,17 +227,22 @@ class AllocationPrice < Orb::Internal::Type::BaseModel # @return [Boolean] required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean - # @!parse - # # The definition of a new allocation price to create and add to the subscription. - # # - # # @param amount [String] - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence] - # # @param currency [String] - # # @param expires_at_end_of_cadence [Boolean] - # # - # def initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice} for more + # details. + # + # The definition of a new allocation price to create and add to the subscription. + # + # @param amount [String] An amount of the currency to allocate to the customer at the specified cadence. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence] The cadence at which to allocate the amount to the customer. + # + # @param currency [String] An ISO 4217 currency string or a custom pricing unit identifier in which to bill + # ... + # + # @param expires_at_end_of_cadence [Boolean] Whether the allocated amount should expire at the end of the cadence or roll ove + # ... # The cadence at which to allocate the amount to the customer. # @@ -275,11 +257,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -309,13 +288,10 @@ class AmountDiscountCreationParams < Orb::Internal::Type::BaseModel # @return [Symbol, :amount] required :discount_type, const: :amount - # @!parse - # # @param amount_discount [Float] - # # @param discount_type [Symbol, :amount] - # # - # def initialize(amount_discount:, discount_type: :amount, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, discount_type: :amount) + # @param amount_discount [Float] Only available if discount_type is `amount`. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountCreationParams < Orb::Internal::Type::BaseModel @@ -331,13 +307,15 @@ class PercentageDiscountCreationParams < Orb::Internal::Type::BaseModel # @return [Float] required :percentage_discount, Float - # @!parse - # # @param percentage_discount [Float] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize(percentage_discount:, discount_type: :percentage, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(percentage_discount:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::PercentageDiscountCreationParams} + # for more details. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`. This is a number between 0 and + # ... + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountCreationParams < Orb::Internal::Type::BaseModel @@ -353,18 +331,19 @@ class UsageDiscountCreationParams < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize(usage_discount:, discount_type: :usage, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::UsageDiscountCreationParams} + # for more details. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::AmountDiscountCreationParams, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::PercentageDiscountCreationParams, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::UsageDiscountCreationParams)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::AmountDiscountCreationParams, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::PercentageDiscountCreationParams, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::UsageDiscountCreationParams)] end # The end date of the price interval. This is the date that the price will stop @@ -378,9 +357,8 @@ module EndDate variant enum: -> { Orb::Models::BillingCycleRelativeDate } - # @!parse - # # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] - # def self.variants; end + # @!method self.variants + # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel @@ -396,13 +374,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, quantity:) + # @param effective_date [Time] The date that the fixed fee quantity transition should take effect. + # + # @param quantity [Integer] The quantity of the fixed fee quantity transition. end # The definition of a new price to create and add to the subscription. @@ -594,45 +569,46 @@ class NewFloatingUnitPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param unit_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::UnitConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :unit] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # name:, - # unit_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :unit, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::UnitConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :unit] # The cadence to bill for this price on. # @@ -647,11 +623,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice#unit_config @@ -662,12 +635,8 @@ class UnitConfig < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param unit_amount [String] - # # - # def initialize(unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:) + # @param unit_amount [String] Rate per unit of usage end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice#billing_cycle_configuration @@ -685,16 +654,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -705,11 +671,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -728,16 +691,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -748,11 +708,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -859,45 +816,46 @@ class NewFloatingPackagePrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param package_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::PackageConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :package] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # name:, - # package_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, name:, package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param package_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::PackageConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :package] # The cadence to bill for this price on. # @@ -912,11 +870,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice#package_config @@ -934,13 +889,15 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @return [Integer] required :package_size, Integer - # @!parse - # # @param package_amount [String] - # # @param package_size [Integer] - # # - # def initialize(package_amount:, package_size:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(package_amount:, package_size:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::PackageConfig} + # for more details. + # + # @param package_amount [String] A currency amount to rate usage by + # + # @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide + # ... end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice#billing_cycle_configuration @@ -958,16 +915,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -978,11 +932,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1001,16 +952,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1021,11 +969,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1132,45 +1077,46 @@ class NewFloatingMatrixPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param matrix_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::MatrixConfig] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :matrix] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # matrix_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :matrix, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, matrix_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param matrix_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::MatrixConfig] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :matrix] # The cadence to bill for this price on. # @@ -1185,11 +1131,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice#matrix_config @@ -1217,14 +1160,12 @@ class MatrixConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param default_unit_amount [String] - # # @param dimensions [Array] - # # @param matrix_values [Array] - # # - # def initialize(default_unit_amount:, dimensions:, matrix_values:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(default_unit_amount:, dimensions:, matrix_values:) + # @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value + # + # @param dimensions [Array] One or two event property values to evaluate matrix groups by + # + # @param matrix_values [Array] Matrix values for specified matrix grouping keys class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values @@ -1241,13 +1182,15 @@ class MatrixValue < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param dimension_values [Array] - # # @param unit_amount [String] - # # - # def initialize(dimension_values:, unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, unit_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::MatrixConfig::MatrixValue} + # for more details. + # + # @param dimension_values [Array] One or two matrix keys to filter usage to this Matrix value by. For example, ["r + # ... + # + # @param unit_amount [String] Unit price for the specified dimension_values end end @@ -1266,16 +1209,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1286,11 +1226,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1309,16 +1246,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1329,11 +1263,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1440,45 +1371,46 @@ class NewFloatingMatrixWithAllocationPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param matrix_with_allocation_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::MatrixWithAllocationConfig] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :matrix_with_allocation] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # matrix_with_allocation_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :matrix_with_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, matrix_with_allocation_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix_with_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param matrix_with_allocation_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::MatrixWithAllocationConfig] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :matrix_with_allocation] # The cadence to bill for this price on. # @@ -1493,11 +1425,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice#matrix_with_allocation_config @@ -1531,15 +1460,14 @@ class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param allocation [Float] - # # @param default_unit_amount [String] - # # @param dimensions [Array] - # # @param matrix_values [Array] - # # - # def initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:) + # @param allocation [Float] Allocation to be used to calculate the price + # + # @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value + # + # @param dimensions [Array] One or two event property values to evaluate matrix groups by + # + # @param matrix_values [Array] Matrix values for specified matrix grouping keys class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values @@ -1556,13 +1484,15 @@ class MatrixValue < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param dimension_values [Array] - # # @param unit_amount [String] - # # - # def initialize(dimension_values:, unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, unit_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue} + # for more details. + # + # @param dimension_values [Array] One or two matrix keys to filter usage to this Matrix value by. For example, ["r + # ... + # + # @param unit_amount [String] Unit price for the specified dimension_values end end @@ -1581,16 +1511,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1601,11 +1528,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1624,16 +1548,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1644,11 +1565,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1755,45 +1673,46 @@ class NewFloatingTieredPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::TieredConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :tiered] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # name:, - # tiered_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :tiered, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::TieredConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :tiered] # The cadence to bill for this price on. # @@ -1808,11 +1727,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice#tiered_config @@ -1824,12 +1740,8 @@ class TieredConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::TieredConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Tiers for rating based on total usage quantities into the specified tier class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit @@ -1850,14 +1762,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :last_unit, Float, nil?: true - # @!parse - # # @param first_unit [Float] - # # @param unit_amount [String] - # # @param last_unit [Float, nil] - # # - # def initialize(first_unit:, unit_amount:, last_unit: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(first_unit:, unit_amount:, last_unit: nil) + # @param first_unit [Float] Exclusive tier starting value + # + # @param unit_amount [String] Amount per unit + # + # @param last_unit [Float, nil] Inclusive tier ending value. If null, this is treated as the last tier end end @@ -1876,16 +1786,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1896,11 +1803,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1919,16 +1823,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1939,11 +1840,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2050,45 +1948,46 @@ class NewFloatingTieredBpsPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_bps_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::TieredBpsConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :tiered_bps] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # name:, - # tiered_bps_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :tiered_bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_bps_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::TieredBpsConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :tiered_bps] # The cadence to bill for this price on. # @@ -2103,11 +2002,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice#tiered_bps_config @@ -2124,12 +2020,13 @@ class TieredBpsConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::TieredBpsConfig} + # for more details. + # + # @param tiers [Array] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -2156,15 +2053,14 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param minimum_amount [String] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Per-event basis point rate + # + # @param minimum_amount [String] Exclusive tier starting value + # + # @param maximum_amount [String, nil] Inclusive tier ending value + # + # @param per_unit_maximum [String, nil] Per unit maximum to charge end end @@ -2183,16 +2079,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2203,11 +2096,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2226,16 +2116,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2246,11 +2133,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2357,45 +2241,46 @@ class NewFloatingBpsPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param bps_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BpsConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :bps] - # # - # def initialize( - # bps_config:, - # cadence:, - # currency:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps_config:, cadence:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice} + # for more details. + # + # @param bps_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BpsConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :bps] # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice#bps_config class BpsConfig < Orb::Internal::Type::BaseModel @@ -2411,13 +2296,10 @@ class BpsConfig < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, per_unit_maximum: nil) + # @param bps [Float] Basis point take rate per event + # + # @param per_unit_maximum [String, nil] Optional currency amount maximum to cap spend per event end # The cadence to bill for this price on. @@ -2433,11 +2315,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice#billing_cycle_configuration @@ -2455,16 +2334,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2475,11 +2351,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2498,16 +2371,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2518,11 +2388,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2629,45 +2496,46 @@ class NewFloatingBulkBpsPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param bulk_bps_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BulkBpsConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :bulk_bps] - # # - # def initialize( - # bulk_bps_config:, - # cadence:, - # currency:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :bulk_bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_bps_config:, cadence:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice} + # for more details. + # + # @param bulk_bps_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BulkBpsConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :bulk_bps] # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice#bulk_bps_config class BulkBpsConfig < Orb::Internal::Type::BaseModel @@ -2679,12 +2547,13 @@ class BulkBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BulkBpsConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BulkBpsConfig} + # for more details. + # + # @param tiers [Array] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -2705,14 +2574,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Basis points to rate on + # + # @param maximum_amount [String, nil] Upper bound for tier + # + # @param per_unit_maximum [String, nil] The maximum amount to charge for any one event end end @@ -2729,11 +2596,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice#billing_cycle_configuration @@ -2751,16 +2615,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2771,11 +2632,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2794,16 +2652,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2814,11 +2669,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2925,45 +2777,46 @@ class NewFloatingBulkPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param bulk_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BulkConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :bulk] - # # - # def initialize( - # bulk_config:, - # cadence:, - # currency:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :bulk, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_config:, cadence:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice} + # for more details. + # + # @param bulk_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BulkConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :bulk] # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice#bulk_config class BulkConfig < Orb::Internal::Type::BaseModel @@ -2974,12 +2827,8 @@ class BulkConfig < Orb::Internal::Type::BaseModel required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BulkConfig::Tier] } - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Bulk tiers for rating based on total usage volume class Tier < Orb::Internal::Type::BaseModel # @!attribute unit_amount @@ -2994,13 +2843,10 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :maximum_units, Float, nil?: true - # @!parse - # # @param unit_amount [String] - # # @param maximum_units [Float, nil] - # # - # def initialize(unit_amount:, maximum_units: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:, maximum_units: nil) + # @param unit_amount [String] Amount per unit + # + # @param maximum_units [Float, nil] Upper bound for this tier end end @@ -3017,11 +2863,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice#billing_cycle_configuration @@ -3039,16 +2882,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3059,11 +2899,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3082,16 +2919,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3102,11 +2936,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3212,45 +3043,46 @@ class NewFloatingThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param threshold_total_amount_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :threshold_total_amount] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # name:, - # threshold_total_amount_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :threshold_total_amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, name:, threshold_total_amount_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :threshold_total_amount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param threshold_total_amount_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :threshold_total_amount] # The cadence to bill for this price on. # @@ -3265,11 +3097,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice#billing_cycle_configuration @@ -3287,16 +3116,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3307,11 +3133,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3330,16 +3153,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3350,11 +3170,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3460,45 +3277,46 @@ class NewFloatingTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_package_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :tiered_package] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # name:, - # tiered_package_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_package_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :tiered_package] # The cadence to bill for this price on. # @@ -3513,11 +3331,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice#billing_cycle_configuration @@ -3535,16 +3350,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3555,11 +3367,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3578,16 +3387,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3598,11 +3404,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3708,45 +3511,46 @@ class NewFloatingGroupedTieredPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::Cadence] - # # @param currency [String] - # # @param grouped_tiered_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :grouped_tiered] - # # - # def initialize( - # cadence:, - # currency:, - # grouped_tiered_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :grouped_tiered, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, grouped_tiered_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param grouped_tiered_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :grouped_tiered] # The cadence to bill for this price on. # @@ -3761,11 +3565,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice#billing_cycle_configuration @@ -3783,16 +3584,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3803,11 +3601,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3826,16 +3621,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3846,11 +3638,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3957,45 +3746,46 @@ class NewFloatingMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param max_group_tiered_package_config [Hash{Symbol=>Object}] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :max_group_tiered_package] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # max_group_tiered_package_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :max_group_tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, max_group_tiered_package_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :max_group_tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param max_group_tiered_package_config [Hash{Symbol=>Object}] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :max_group_tiered_package] # The cadence to bill for this price on. # @@ -4010,11 +3800,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice#billing_cycle_configuration @@ -4032,16 +3819,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4052,11 +3836,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4075,16 +3856,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4095,11 +3873,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4205,45 +3980,46 @@ class NewFloatingTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_with_minimum_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :tiered_with_minimum] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # name:, - # tiered_with_minimum_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :tiered_with_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_with_minimum_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :tiered_with_minimum] # The cadence to bill for this price on. # @@ -4258,11 +4034,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice#billing_cycle_configuration @@ -4280,16 +4053,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4300,11 +4070,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4323,16 +4090,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4343,11 +4107,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4454,45 +4215,46 @@ class NewFloatingPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param package_with_allocation_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :package_with_allocation] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # name:, - # package_with_allocation_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :package_with_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, name:, package_with_allocation_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package_with_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param package_with_allocation_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :package_with_allocation] # The cadence to bill for this price on. # @@ -4507,11 +4269,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice#billing_cycle_configuration @@ -4529,16 +4288,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4549,11 +4305,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4572,16 +4325,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4592,11 +4342,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4703,45 +4450,46 @@ class NewFloatingTieredPackageWithMinimumPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_package_with_minimum_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :tiered_package_with_minimum] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # name:, - # tiered_package_with_minimum_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :tiered_package_with_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, name:, tiered_package_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_package_with_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_package_with_minimum_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :tiered_package_with_minimum] # The cadence to bill for this price on. # @@ -4756,11 +4504,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice#billing_cycle_configuration @@ -4778,16 +4523,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4798,11 +4540,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4821,16 +4560,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4841,11 +4577,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4951,45 +4684,46 @@ class NewFloatingUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param unit_with_percent_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :unit_with_percent] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # name:, - # unit_with_percent_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :unit_with_percent, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_percent) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_with_percent_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :unit_with_percent] # The cadence to bill for this price on. # @@ -5004,11 +4738,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice#billing_cycle_configuration @@ -5026,16 +4757,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5046,11 +4774,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5069,16 +4794,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5089,11 +4811,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5199,45 +4918,46 @@ class NewFloatingTieredWithProrationPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_with_proration_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :tiered_with_proration] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # name:, - # tiered_with_proration_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :tiered_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, name:, tiered_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_with_proration_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :tiered_with_proration] # The cadence to bill for this price on. # @@ -5252,11 +4972,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice#billing_cycle_configuration @@ -5274,16 +4991,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5294,11 +5008,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5317,16 +5028,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5337,11 +5045,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5447,51 +5152,52 @@ class NewFloatingUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param unit_with_proration_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :unit_with_proration] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # name:, - # unit_with_proration_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :unit_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void - - # The cadence to bill for this price on. + # @!method initialize(cadence:, currency:, item_id:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice} + # for more details. # - # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice#cadence - module Cadence - extend Orb::Internal::Type::Enum + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_with_proration_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :unit_with_proration] + + # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice#cadence + module Cadence + extend Orb::Internal::Type::Enum ANNUAL = :annual SEMI_ANNUAL = :semi_annual @@ -5500,11 +5206,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice#billing_cycle_configuration @@ -5522,16 +5225,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5542,11 +5242,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5565,16 +5262,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5585,11 +5279,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5695,45 +5386,46 @@ class NewFloatingGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::Cadence] - # # @param currency [String] - # # @param grouped_allocation_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :grouped_allocation] - # # - # def initialize( - # cadence:, - # currency:, - # grouped_allocation_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :grouped_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, grouped_allocation_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param grouped_allocation_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :grouped_allocation] # The cadence to bill for this price on. # @@ -5748,11 +5440,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice#billing_cycle_configuration @@ -5770,16 +5459,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5790,11 +5476,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5813,16 +5496,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5833,11 +5513,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5944,45 +5621,46 @@ class NewFloatingGroupedWithProratedMinimumPrice < Orb::Internal::Type::BaseMode # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::Cadence] - # # @param currency [String] - # # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :grouped_with_prorated_minimum] - # # - # def initialize( - # cadence:, - # currency:, - # grouped_with_prorated_minimum_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :grouped_with_prorated_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, grouped_with_prorated_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_with_prorated_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :grouped_with_prorated_minimum] # The cadence to bill for this price on. # @@ -5997,11 +5675,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice#billing_cycle_configuration @@ -6019,16 +5694,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6039,11 +5711,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6062,16 +5731,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6082,11 +5748,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6193,45 +5856,46 @@ class NewFloatingGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::Cadence] - # # @param currency [String] - # # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :grouped_with_metered_minimum] - # # - # def initialize( - # cadence:, - # currency:, - # grouped_with_metered_minimum_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :grouped_with_metered_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, grouped_with_metered_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_with_metered_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :grouped_with_metered_minimum] # The cadence to bill for this price on. # @@ -6246,11 +5910,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice#billing_cycle_configuration @@ -6268,16 +5929,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6288,11 +5946,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6311,16 +5966,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6331,11 +5983,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6442,45 +6091,46 @@ class NewFloatingMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param matrix_with_display_name_config [Hash{Symbol=>Object}] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :matrix_with_display_name] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # matrix_with_display_name_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :matrix_with_display_name, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, matrix_with_display_name_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix_with_display_name) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param matrix_with_display_name_config [Hash{Symbol=>Object}] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :matrix_with_display_name] # The cadence to bill for this price on. # @@ -6495,11 +6145,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice#billing_cycle_configuration @@ -6517,16 +6164,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6537,11 +6181,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6560,16 +6201,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6580,11 +6218,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6690,45 +6325,46 @@ class NewFloatingBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param bulk_with_proration_config [Hash{Symbol=>Object}] - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :bulk_with_proration] - # # - # def initialize( - # bulk_with_proration_config:, - # cadence:, - # currency:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :bulk_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_with_proration_config:, cadence:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice} + # for more details. + # + # @param bulk_with_proration_config [Hash{Symbol=>Object}] + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :bulk_with_proration] # The cadence to bill for this price on. # @@ -6743,11 +6379,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice#billing_cycle_configuration @@ -6765,16 +6398,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6785,11 +6415,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6808,16 +6435,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6828,11 +6452,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6938,45 +6559,46 @@ class NewFloatingGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::Cadence] - # # @param currency [String] - # # @param grouped_tiered_package_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :grouped_tiered_package] - # # - # def initialize( - # cadence:, - # currency:, - # grouped_tiered_package_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :grouped_tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, grouped_tiered_package_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param grouped_tiered_package_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :grouped_tiered_package] # The cadence to bill for this price on. # @@ -6991,11 +6613,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice#billing_cycle_configuration @@ -7013,16 +6632,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7033,11 +6649,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7056,16 +6669,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7076,11 +6686,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -7187,45 +6794,46 @@ class NewFloatingScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::BaseM # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :scalable_matrix_with_unit_pricing] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # name:, - # scalable_matrix_with_unit_pricing_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :scalable_matrix_with_unit_pricing, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, name:, scalable_matrix_with_unit_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :scalable_matrix_with_unit_pricing) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :scalable_matrix_with_unit_pricing] # The cadence to bill for this price on. # @@ -7240,11 +6848,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice#billing_cycle_configuration @@ -7262,16 +6867,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7282,11 +6884,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7305,16 +6904,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7325,11 +6921,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -7436,45 +7029,46 @@ class NewFloatingScalableMatrixWithTieredPricingPrice < Orb::Internal::Type::Bas # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::Cadence] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :scalable_matrix_with_tiered_pricing] - # # - # def initialize( - # cadence:, - # currency:, - # item_id:, - # name:, - # scalable_matrix_with_tiered_pricing_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :scalable_matrix_with_tiered_pricing, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, currency:, item_id:, name:, scalable_matrix_with_tiered_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :scalable_matrix_with_tiered_pricing) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :scalable_matrix_with_tiered_pricing] # The cadence to bill for this price on. # @@ -7489,11 +7083,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice#billing_cycle_configuration @@ -7511,16 +7102,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7531,11 +7119,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7554,16 +7139,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7574,11 +7156,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -7685,45 +7264,46 @@ class NewFloatingCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::Cadence] - # # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] - # # @param currency [String] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param model_type [Symbol, :cumulative_grouped_bulk] - # # - # def initialize( - # cadence:, - # cumulative_grouped_bulk_config:, - # currency:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # model_type: :cumulative_grouped_bulk, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, cumulative_grouped_bulk_config:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :cumulative_grouped_bulk) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::Cadence] The cadence to bill for this price on. + # + # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param model_type [Symbol, :cumulative_grouped_bulk] # The cadence to bill for this price on. # @@ -7738,11 +7318,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice#billing_cycle_configuration @@ -7760,16 +7337,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7780,11 +7354,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7803,16 +7374,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7823,18 +7391,14 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end - # @!parse - # # @return [Array(Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice)] end end @@ -7867,14 +7431,17 @@ class AddAdjustment < Orb::Internal::Type::BaseModel union: -> { Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::EndDate }, nil?: true - # @!parse - # # @param adjustment [Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewMaximum] - # # @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] - # # @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] - # # - # def initialize(adjustment:, start_date:, end_date: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(adjustment:, start_date:, end_date: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment} for more details. + # + # @param adjustment [Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewMaximum] The definition of a new adjustment to create and add to the subscription. + # + # @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The start date of the adjustment interval. This is the date that the adjustment + # ... + # + # @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The end date of the adjustment interval. This is the date that the adjustment wi + # ... # The definition of a new adjustment to create and add to the subscription. # @@ -7916,34 +7483,26 @@ class NewPercentageDiscount < Orb::Internal::Type::BaseModel # @return [Float] required :percentage_discount, Float - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param percentage_discount [Float] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # applies_to_price_ids:, - # percentage_discount:, - # is_invoice_level: nil, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, percentage_discount:, is_invoice_level: nil, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewPercentageDiscount} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param percentage_discount [Float] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :percentage_discount] end class NewUsageDiscount < Orb::Internal::Type::BaseModel @@ -7963,26 +7522,26 @@ class NewUsageDiscount < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param usage_discount [Float] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize(applies_to_price_ids:, usage_discount:, is_invoice_level: nil, adjustment_type: :usage_discount, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, usage_discount:, is_invoice_level: nil, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewUsageDiscount} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param usage_discount [Float] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class NewAmountDiscount < Orb::Internal::Type::BaseModel @@ -8002,26 +7561,26 @@ class NewAmountDiscount < Orb::Internal::Type::BaseModel # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize(amount_discount:, applies_to_price_ids:, is_invoice_level: nil, adjustment_type: :amount_discount, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, is_invoice_level: nil, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewAmountDiscount} + # for more details. + # + # @param amount_discount [String] + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :amount_discount] end class NewMinimum < Orb::Internal::Type::BaseModel @@ -8047,27 +7606,28 @@ class NewMinimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize(applies_to_price_ids:, item_id:, minimum_amount:, is_invoice_level: nil, adjustment_type: :minimum, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, item_id:, minimum_amount:, is_invoice_level: nil, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewMinimum} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :minimum] end class NewMaximum < Orb::Internal::Type::BaseModel @@ -8087,31 +7647,30 @@ class NewMaximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, is_invoice_level: nil, adjustment_type: :maximum, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:, is_invoice_level: nil, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewMaximum} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param maximum_amount [String] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewMaximum)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewMaximum)] end # The start date of the adjustment interval. This is the date that the adjustment @@ -8127,9 +7686,8 @@ module StartDate variant enum: -> { Orb::Models::BillingCycleRelativeDate } - # @!parse - # # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] - # def self.variants; end + # @!method self.variants + # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] end # The end date of the adjustment interval. This is the date that the adjustment @@ -8145,9 +7703,8 @@ module EndDate variant enum: -> { Orb::Models::BillingCycleRelativeDate } - # @!parse - # # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] - # def self.variants; end + # @!method self.variants + # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] end end @@ -8192,17 +7749,13 @@ class Edit < Orb::Internal::Type::BaseModel -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition] }, nil?: true - # @!attribute [r] start_date + # @!attribute start_date # The updated start date of this price interval. If not specified, the start date # will not be updated. # # @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] optional :start_date, union: -> { Orb::Models::SubscriptionPriceIntervalsParams::Edit::StartDate } - # @!parse - # # @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate] - # attr_writer :start_date - # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under # this subscription. By default, a subscription only considers usage events @@ -8214,29 +7767,29 @@ class Edit < Orb::Internal::Type::BaseModel # @return [Array, nil] optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # @param price_interval_id [String] - # # @param billing_cycle_day [Integer, nil] - # # @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # price_interval_id:, - # billing_cycle_day: nil, - # end_date: nil, - # filter: nil, - # fixed_fee_quantity_transitions: nil, - # start_date: nil, - # usage_customer_ids: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(price_interval_id:, billing_cycle_day: nil, end_date: nil, filter: nil, fixed_fee_quantity_transitions: nil, start_date: nil, usage_customer_ids: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::Edit} for more details. + # + # @param price_interval_id [String] The id of the price interval to edit. + # + # @param billing_cycle_day [Integer, nil] The updated billing cycle day for this price interval. If not specified, the bil + # ... + # + # @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The updated end date of this price interval. If not specified, the start date wi + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. This filter must be expressed as + # ... + # + # @param fixed_fee_quantity_transitions [Array, nil] A list of fixed fee quantity transitions to use for this price interval. Note th + # ... + # + # @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The updated start date of this price interval. If not specified, the start date + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... # The updated end date of this price interval. If not specified, the start date # will not be updated. @@ -8249,9 +7802,8 @@ module EndDate variant enum: -> { Orb::Models::BillingCycleRelativeDate } - # @!parse - # # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] - # def self.variants; end + # @!method self.variants + # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel @@ -8267,13 +7819,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, quantity:) + # @param effective_date [Time] The date that the fixed fee quantity transition should take effect. + # + # @param quantity [Integer] The quantity of the fixed fee quantity transition. end # The updated start date of this price interval. If not specified, the start date @@ -8287,9 +7836,8 @@ module StartDate variant enum: -> { Orb::Models::BillingCycleRelativeDate } - # @!parse - # # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] - # def self.variants; end + # @!method self.variants + # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] end end @@ -8309,7 +7857,7 @@ class EditAdjustment < Orb::Internal::Type::BaseModel union: -> { Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment::EndDate }, nil?: true - # @!attribute [r] start_date + # @!attribute start_date # The updated start date of this adjustment interval. If not specified, the start # date will not be updated. # @@ -8317,18 +7865,18 @@ class EditAdjustment < Orb::Internal::Type::BaseModel optional :start_date, union: -> { Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment::StartDate } - # @!parse - # # @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate] - # attr_writer :start_date - - # @!parse - # # @param adjustment_interval_id [String] - # # @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] - # # @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] - # # - # def initialize(adjustment_interval_id:, end_date: nil, start_date: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(adjustment_interval_id:, end_date: nil, start_date: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment} for more + # details. + # + # @param adjustment_interval_id [String] The id of the adjustment interval to edit. + # + # @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The updated end date of this adjustment interval. If not specified, the start da + # ... + # + # @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The updated start date of this adjustment interval. If not specified, the start + # ... # The updated end date of this adjustment interval. If not specified, the start # date will not be updated. @@ -8341,9 +7889,8 @@ module EndDate variant enum: -> { Orb::Models::BillingCycleRelativeDate } - # @!parse - # # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] - # def self.variants; end + # @!method self.variants + # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] end # The updated start date of this adjustment interval. If not specified, the start @@ -8357,9 +7904,8 @@ module StartDate variant enum: -> { Orb::Models::BillingCycleRelativeDate } - # @!parse - # # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] - # def self.variants; end + # @!method self.variants + # @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)] end end end diff --git a/lib/orb/models/subscription_price_intervals_response.rb b/lib/orb/models/subscription_price_intervals_response.rb index 06650f70..853f87b7 100644 --- a/lib/orb/models/subscription_price_intervals_response.rb +++ b/lib/orb/models/subscription_price_intervals_response.rb @@ -211,69 +211,75 @@ class SubscriptionPriceIntervalsResponse < Orb::Internal::Type::BaseModel -> { Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources }, nil?: true - # @!parse - # # @param id [String] - # # @param active_plan_phase_order [Integer, nil] - # # @param adjustment_intervals [Array] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionPriceIntervalsResponse::BillingCycleAnchorConfiguration] - # # @param billing_cycle_day [Integer] - # # @param created_at [Time] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param customer [Orb::Models::Customer] - # # @param default_invoice_memo [String, nil] - # # @param discount_intervals [Array] - # # @param end_date [Time, nil] - # # @param fixed_fee_quantity_schedule [Array] - # # @param invoicing_threshold [String, nil] - # # @param maximum_intervals [Array] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum_intervals [Array] - # # @param net_terms [Integer] - # # @param pending_subscription_change [Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange, nil] - # # @param plan [Orb::Models::Plan] - # # @param price_intervals [Array] - # # @param redeemed_coupon [Orb::Models::SubscriptionPriceIntervalsResponse::RedeemedCoupon, nil] - # # @param start_date [Time] - # # @param status [Symbol, Orb::Models::SubscriptionPriceIntervalsResponse::Status] - # # @param trial_info [Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo] - # # @param changed_resources [Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources, nil] - # # - # def initialize( - # id:, - # active_plan_phase_order:, - # adjustment_intervals:, - # auto_collection:, - # billing_cycle_anchor_configuration:, - # billing_cycle_day:, - # created_at:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # customer:, - # default_invoice_memo:, - # discount_intervals:, - # end_date:, - # fixed_fee_quantity_schedule:, - # invoicing_threshold:, - # maximum_intervals:, - # metadata:, - # minimum_intervals:, - # net_terms:, - # pending_subscription_change:, - # plan:, - # price_intervals:, - # redeemed_coupon:, - # start_date:, - # status:, - # trial_info:, - # changed_resources: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsResponse} for more details. + # + # @param id [String] + # + # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase + # ... + # + # @param adjustment_intervals [Array] The adjustment intervals for this subscription sorted by the start_date of the a + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionPriceIntervalsResponse::BillingCycleAnchorConfiguration] + # + # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param created_at [Time] + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i + # ... + # + # @param discount_intervals [Array] The discount intervals for this subscription sorted by the start_date. + # + # @param end_date [Time, nil] The date Orb stops billing for this subscription. + # + # @param fixed_fee_quantity_schedule [Array] + # + # @param invoicing_threshold [String, nil] + # + # @param maximum_intervals [Array] The maximum intervals for this subscription sorted by the start_date. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum_intervals [Array] The minimum intervals for this subscription sorted by the start_date. + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param pending_subscription_change [Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription. + # + # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # ... + # + # @param price_intervals [Array] The price intervals for this subscription. + # + # @param redeemed_coupon [Orb::Models::SubscriptionPriceIntervalsResponse::RedeemedCoupon, nil] + # + # @param start_date [Time] The date Orb starts billing for this subscription. + # + # @param status [Symbol, Orb::Models::SubscriptionPriceIntervalsResponse::Status] + # + # @param trial_info [Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo] + # + # @param changed_resources [Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet + # ... class AdjustmentInterval < Orb::Internal::Type::BaseModel # @!attribute id @@ -305,16 +311,16 @@ class AdjustmentInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param id [String] - # # @param adjustment [Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) + # @param id [String] + # + # @param adjustment [Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # + # @param applies_to_price_interval_ids [Array] The price interval IDs that this adjustment applies to. + # + # @param end_date [Time, nil] The end date of the adjustment interval. + # + # @param start_date [Time] The start date of the adjustment interval. # @see Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval#adjustment module Adjustment @@ -380,29 +386,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -448,29 +451,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -516,29 +516,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -590,31 +587,28 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -660,34 +654,30 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] end end @@ -717,14 +707,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsResponse::BillingCycleAnchorConfiguration} + # for more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end module DiscountInterval @@ -777,27 +772,18 @@ class AmountDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param discount_type [Symbol, :amount] - # # - # def initialize( - # amount_discount:, - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # discount_type: :amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount) + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -837,27 +823,23 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param percentage_discount [Float] - # # @param start_date [Time] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # percentage_discount:, - # start_date:, - # discount_type: :percentage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::PercentageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1 + # ... + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -897,32 +879,27 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # usage_discount:, - # discount_type: :usage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::UsageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::UsageDiscountInterval)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::UsageDiscountInterval)] end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -946,15 +923,11 @@ class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param end_date [Time, nil] - # # @param price_id [String] - # # @param quantity [Float] - # # @param start_date [Time] - # # - # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, price_id:, quantity:, start_date:) + # @param end_date [Time, nil] + # @param price_id [String] + # @param quantity [Float] + # @param start_date [Time] end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -989,16 +962,21 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param maximum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsResponse::MaximumInterval} for more + # details. + # + # @param applies_to_price_ids [Array] The price ids that this maximum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this maximum interval applies to. + # + # @param end_date [Time, nil] The end date of the maximum interval. + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the maximum interval. end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1033,16 +1011,21 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param minimum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsResponse::MinimumInterval} for more + # details. + # + # @param applies_to_price_ids [Array] The price ids that this minimum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this minimum interval applies to. + # + # @param end_date [Time, nil] The end date of the minimum interval. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the minimum interval. end # @see Orb::Models::SubscriptionPriceIntervalsResponse#pending_subscription_change @@ -1052,14 +1035,10 @@ class PendingSubscriptionChange < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # A pending subscription change if one exists on this subscription. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # A pending subscription change if one exists on this subscription. + # + # @param id [String] end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1141,39 +1120,41 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. - # # - # # @param id [String] - # # @param billing_cycle_day [Integer] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param end_date [Time, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param start_date [Time] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # billing_cycle_day:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # end_date:, - # filter:, - # fixed_fee_quantity_transitions:, - # price:, - # start_date:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval} for more + # details. + # + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + # + # @param id [String] + # + # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. + # + # @param fixed_fee_quantity_transitions [Array, nil] The fixed fee quantity transitions for this price interval. This is only relevan + # ... + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @!attribute effective_date @@ -1191,14 +1172,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param price_id [String] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, price_id:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, price_id:, quantity:) + # @param effective_date [Time] + # @param price_id [String] + # @param quantity [Integer] end end @@ -1219,14 +1196,10 @@ class RedeemedCoupon < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param coupon_id [String] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(coupon_id:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(coupon_id:, end_date:, start_date:) + # @param coupon_id [String] + # @param end_date [Time, nil] + # @param start_date [Time] end # @see Orb::Models::SubscriptionPriceIntervalsResponse#status @@ -1237,11 +1210,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionPriceIntervalsResponse#trial_info @@ -1251,12 +1221,8 @@ class TrialInfo < Orb::Internal::Type::BaseModel # @return [Time, nil] required :end_date, Time, nil?: true - # @!parse - # # @param end_date [Time, nil] - # # - # def initialize(end_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:) + # @param end_date [Time, nil] end # @see Orb::Models::SubscriptionPriceIntervalsResponse#changed_resources @@ -1285,19 +1251,18 @@ class ChangedResources < Orb::Internal::Type::BaseModel # @return [Array] required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } - # @!parse - # # The resources that were changed as part of this operation. Only present when - # # fetched through the subscription changes API or if the - # # `include_changed_resources` parameter was passed in the request. - # # - # # @param created_credit_notes [Array] - # # @param created_invoices [Array] - # # @param voided_credit_notes [Array] - # # @param voided_invoices [Array] - # # - # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:) + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @param created_credit_notes [Array] The credit notes that were created as part of this operation. + # + # @param created_invoices [Array] The invoices that were created as part of this operation. + # + # @param voided_credit_notes [Array] The credit notes that were voided as part of this operation. + # + # @param voided_invoices [Array] The invoices that were voided as part of this operation. end end end diff --git a/lib/orb/models/subscription_schedule_plan_change_params.rb b/lib/orb/models/subscription_schedule_plan_change_params.rb index 88b2d5ce..9f17088e 100644 --- a/lib/orb/models/subscription_schedule_plan_change_params.rb +++ b/lib/orb/models/subscription_schedule_plan_change_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Subscriptions#schedule_plan_change class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute change_option @@ -80,6 +79,7 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel optional :coupon_redemption_code, String, nil?: true # @!attribute credits_overage_rate + # @deprecated # # @return [Float, nil] optional :credits_overage_rate, Float, nil?: true @@ -130,6 +130,7 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel optional :net_terms, Integer, nil?: true # @!attribute per_credit_overage_amount + # @deprecated # # @return [Float, nil] optional :per_credit_overage_amount, Float, nil?: true @@ -149,6 +150,8 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel optional :plan_version_number, Integer, nil?: true # @!attribute price_overrides + # @deprecated + # # Optionally provide a list of overrides for prices on the plan # # @return [Array, nil] @@ -210,69 +213,83 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel # @return [Array, nil] optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # @param change_option [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption] - # # @param add_adjustments [Array, nil] - # # @param add_prices [Array, nil] - # # @param align_billing_with_plan_change_date [Boolean, nil] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_alignment [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAnchorConfiguration, nil] - # # @param change_date [Time, nil] - # # @param coupon_redemption_code [String, nil] - # # @param credits_overage_rate [Float, nil] - # # @param default_invoice_memo [String, nil] - # # @param external_plan_id [String, nil] - # # @param filter [String, nil] - # # @param initial_phase_order [Integer, nil] - # # @param invoicing_threshold [String, nil] - # # @param net_terms [Integer, nil] - # # @param per_credit_overage_amount [Float, nil] - # # @param plan_id [String, nil] - # # @param plan_version_number [Integer, nil] - # # @param price_overrides [Array, nil] - # # @param remove_adjustments [Array, nil] - # # @param remove_prices [Array, nil] - # # @param replace_adjustments [Array, nil] - # # @param replace_prices [Array, nil] - # # @param trial_duration_days [Integer, nil] - # # @param usage_customer_ids [Array, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # change_option:, - # add_adjustments: nil, - # add_prices: nil, - # align_billing_with_plan_change_date: nil, - # auto_collection: nil, - # billing_cycle_alignment: nil, - # billing_cycle_anchor_configuration: nil, - # change_date: nil, - # coupon_redemption_code: nil, - # credits_overage_rate: nil, - # default_invoice_memo: nil, - # external_plan_id: nil, - # filter: nil, - # initial_phase_order: nil, - # invoicing_threshold: nil, - # net_terms: nil, - # per_credit_overage_amount: nil, - # plan_id: nil, - # plan_version_number: nil, - # price_overrides: nil, - # remove_adjustments: nil, - # remove_prices: nil, - # replace_adjustments: nil, - # replace_prices: nil, - # trial_duration_days: nil, - # usage_customer_ids: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(change_option:, add_adjustments: nil, add_prices: nil, align_billing_with_plan_change_date: nil, auto_collection: nil, billing_cycle_alignment: nil, billing_cycle_anchor_configuration: nil, change_date: nil, coupon_redemption_code: nil, credits_overage_rate: nil, default_invoice_memo: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams} for more details. + # + # @param change_option [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption] + # + # @param add_adjustments [Array, nil] Additional adjustments to be added to the subscription. (Only available for acco + # ... + # + # @param add_prices [Array, nil] Additional prices to be added to the subscription. (Only available for accounts + # ... + # + # @param align_billing_with_plan_change_date [Boolean, nil] [DEPRECATED] Use billing_cycle_alignment instead. Reset billing periods to be al + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_alignment [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment, nil] Reset billing periods to be aligned with the plan change's effective date or sta + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAnchorConfiguration, nil] + # + # @param change_date [Time, nil] The date that the plan change should take effect. This parameter can only be pas + # ... + # + # @param coupon_redemption_code [String, nil] Redemption code to be used for this subscription. If the coupon cannot be found + # ... + # + # @param credits_overage_rate [Float, nil] + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscription's invoices. Note that if this i + # ... + # + # @param external_plan_id [String, nil] The external_plan_id of the plan that the given subscription should be switched + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. This filter must be expressed as + # ... + # + # @param initial_phase_order [Integer, nil] The phase of the plan to start with + # + # @param invoicing_threshold [String, nil] When this subscription's accrued usage reaches this threshold, an invoice will b + # ... + # + # @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d + # ... + # + # @param per_credit_overage_amount [Float, nil] + # + # @param plan_id [String, nil] The plan that the given subscription should be switched to. Note that either thi + # ... + # + # @param plan_version_number [Integer, nil] Specifies which version of the plan to change to. If null, the default version w + # ... + # + # @param price_overrides [Array, nil] Optionally provide a list of overrides for prices on the plan + # + # @param remove_adjustments [Array, nil] Plan adjustments to be removed from the subscription. (Only available for accoun + # ... + # + # @param remove_prices [Array, nil] Plan prices to be removed from the subscription. (Only available for accounts th + # ... + # + # @param replace_adjustments [Array, nil] Plan adjustments to be replaced with additional adjustments on the subscription. + # ... + # + # @param replace_prices [Array, nil] Plan prices to be replaced with additional prices on the subscription. (Only ava + # ... + # + # @param trial_duration_days [Integer, nil] The duration of the trial period in days. If not provided, this defaults to the + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] module ChangeOption extend Orb::Internal::Type::Enum @@ -281,11 +298,8 @@ module ChangeOption END_OF_SUBSCRIPTION_TERM = :end_of_subscription_term IMMEDIATE = :immediate - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class AddAdjustment < Orb::Internal::Type::BaseModel @@ -317,15 +331,20 @@ class AddAdjustment < Orb::Internal::Type::BaseModel # @return [Time, nil] optional :start_date, Time, nil?: true - # @!parse - # # @param adjustment [Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewMaximum] - # # @param end_date [Time, nil] - # # @param plan_phase_order [Integer, nil] - # # @param start_date [Time, nil] - # # - # def initialize(adjustment:, end_date: nil, plan_phase_order: nil, start_date: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(adjustment:, end_date: nil, plan_phase_order: nil, start_date: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment} for more + # details. + # + # @param adjustment [Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewMaximum] The definition of a new adjustment to create and add to the subscription. + # + # @param end_date [Time, nil] The end date of the adjustment interval. This is the date that the adjustment wi + # ... + # + # @param plan_phase_order [Integer, nil] The phase to add this adjustment to. + # + # @param start_date [Time, nil] The start date of the adjustment interval. This is the date that the adjustment + # ... # The definition of a new adjustment to create and add to the subscription. # @@ -367,34 +386,26 @@ class NewPercentageDiscount < Orb::Internal::Type::BaseModel # @return [Float] required :percentage_discount, Float - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param percentage_discount [Float] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # applies_to_price_ids:, - # percentage_discount:, - # is_invoice_level: nil, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, percentage_discount:, is_invoice_level: nil, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewPercentageDiscount} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param percentage_discount [Float] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :percentage_discount] end class NewUsageDiscount < Orb::Internal::Type::BaseModel @@ -414,26 +425,26 @@ class NewUsageDiscount < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param usage_discount [Float] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize(applies_to_price_ids:, usage_discount:, is_invoice_level: nil, adjustment_type: :usage_discount, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, usage_discount:, is_invoice_level: nil, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewUsageDiscount} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param usage_discount [Float] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class NewAmountDiscount < Orb::Internal::Type::BaseModel @@ -453,26 +464,26 @@ class NewAmountDiscount < Orb::Internal::Type::BaseModel # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize(amount_discount:, applies_to_price_ids:, is_invoice_level: nil, adjustment_type: :amount_discount, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, is_invoice_level: nil, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewAmountDiscount} + # for more details. + # + # @param amount_discount [String] + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :amount_discount] end class NewMinimum < Orb::Internal::Type::BaseModel @@ -498,27 +509,28 @@ class NewMinimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize(applies_to_price_ids:, item_id:, minimum_amount:, is_invoice_level: nil, adjustment_type: :minimum, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, item_id:, minimum_amount:, is_invoice_level: nil, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewMinimum} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :minimum] end class NewMaximum < Orb::Internal::Type::BaseModel @@ -538,31 +550,30 @@ class NewMaximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, is_invoice_level: nil, adjustment_type: :maximum, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:, is_invoice_level: nil, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewMaximum} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param maximum_amount [String] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewMaximum)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewMaximum)] end end @@ -576,6 +587,8 @@ class AddPrice < Orb::Internal::Type::BaseModel nil?: true # @!attribute discounts + # @deprecated + # # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for this # price. # @@ -599,6 +612,8 @@ class AddPrice < Orb::Internal::Type::BaseModel optional :external_price_id, String, nil?: true # @!attribute maximum_amount + # @deprecated + # # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for # this price. # @@ -606,6 +621,8 @@ class AddPrice < Orb::Internal::Type::BaseModel optional :maximum_amount, String, nil?: true # @!attribute minimum_amount + # @deprecated + # # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for # this price. # @@ -640,35 +657,34 @@ class AddPrice < Orb::Internal::Type::BaseModel # @return [Time, nil] optional :start_date, Time, nil?: true - # @!parse - # # @param allocation_price [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice, nil] - # # @param discounts [Array, nil] - # # @param end_date [Time, nil] - # # @param external_price_id [String, nil] - # # @param maximum_amount [String, nil] - # # @param minimum_amount [String, nil] - # # @param plan_phase_order [Integer, nil] - # # @param price [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice, nil] - # # @param price_id [String, nil] - # # @param start_date [Time, nil] - # # - # def initialize( - # allocation_price: nil, - # discounts: nil, - # end_date: nil, - # external_price_id: nil, - # maximum_amount: nil, - # minimum_amount: nil, - # plan_phase_order: nil, - # price: nil, - # price_id: nil, - # start_date: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allocation_price: nil, discounts: nil, end_date: nil, external_price_id: nil, maximum_amount: nil, minimum_amount: nil, plan_phase_order: nil, price: nil, price_id: nil, start_date: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice} for more details. + # + # @param allocation_price [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice, nil] The definition of a new allocation price to create and add to the subscription. + # + # @param discounts [Array, nil] [DEPRECATED] Use add_adjustments instead. The subscription's discounts for this + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that the price will stop bi + # ... + # + # @param external_price_id [String, nil] The external price id of the price to add to the subscription. + # + # @param maximum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for + # ... + # + # @param minimum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for + # ... + # + # @param plan_phase_order [Integer, nil] The phase to add this price to. + # + # @param price [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice, nil] The definition of a new price to create and add to the subscription. + # + # @param price_id [String, nil] The id of the price to add to the subscription. + # + # @param start_date [Time, nil] The start date of the price interval. This is the date that the price will start + # ... # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice#allocation_price class AllocationPrice < Orb::Internal::Type::BaseModel @@ -699,17 +715,22 @@ class AllocationPrice < Orb::Internal::Type::BaseModel # @return [Boolean] required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean - # @!parse - # # The definition of a new allocation price to create and add to the subscription. - # # - # # @param amount [String] - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::Cadence] - # # @param currency [String] - # # @param expires_at_end_of_cadence [Boolean] - # # - # def initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice} + # for more details. + # + # The definition of a new allocation price to create and add to the subscription. + # + # @param amount [String] An amount of the currency to allocate to the customer at the specified cadence. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::Cadence] The cadence at which to allocate the amount to the customer. + # + # @param currency [String] An ISO 4217 currency string or a custom pricing unit identifier in which to bill + # ... + # + # @param expires_at_end_of_cadence [Boolean] Whether the allocated amount should expire at the end of the cadence or roll ove + # ... # The cadence at which to allocate the amount to the customer. # @@ -724,11 +745,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -759,15 +777,20 @@ class Discount < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :usage_discount, Float, nil?: true - # @!parse - # # @param discount_type [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Discount::DiscountType] - # # @param amount_discount [String, nil] - # # @param percentage_discount [Float, nil] - # # @param usage_discount [Float, nil] - # # - # def initialize(discount_type:, amount_discount: nil, percentage_discount: nil, usage_discount: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(discount_type:, amount_discount: nil, percentage_discount: nil, usage_discount: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Discount} for more + # details. + # + # @param discount_type [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Discount::DiscountType] + # + # @param amount_discount [String, nil] Only available if discount_type is `amount`. + # + # @param percentage_discount [Float, nil] Only available if discount_type is `percentage`. This is a number between 0 and + # ... + # + # @param usage_discount [Float, nil] Only available if discount_type is `usage`. Number of usage units that this disc + # ... # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Discount#discount_type module DiscountType @@ -777,11 +800,8 @@ module DiscountType USAGE = :usage AMOUNT = :amount - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -978,47 +998,50 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::UnitConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :unit] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :unit, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :unit) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::UnitConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :unit] # The cadence to bill for this price on. # @@ -1033,11 +1056,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice#unit_config @@ -1048,12 +1068,8 @@ class UnitConfig < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param unit_amount [String] - # # - # def initialize(unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:) + # @param unit_amount [String] Rate per unit of usage end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice#billing_cycle_configuration @@ -1071,16 +1087,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1091,11 +1104,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1114,16 +1124,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1134,11 +1141,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1253,47 +1257,50 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param package_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::PackageConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :package] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # package_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param package_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::PackageConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :package] # The cadence to bill for this price on. # @@ -1308,11 +1315,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice#package_config @@ -1330,13 +1334,15 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @return [Integer] required :package_size, Integer - # @!parse - # # @param package_amount [String] - # # @param package_size [Integer] - # # - # def initialize(package_amount:, package_size:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(package_amount:, package_size:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::PackageConfig} + # for more details. + # + # @param package_amount [String] A currency amount to rate usage by + # + # @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide + # ... end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice#billing_cycle_configuration @@ -1354,16 +1360,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1374,11 +1377,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1397,16 +1397,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1417,11 +1414,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1536,47 +1530,50 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence] - # # @param item_id [String] - # # @param matrix_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :matrix] - # # - # def initialize( - # cadence:, - # item_id:, - # matrix_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :matrix, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, matrix_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :matrix) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param matrix_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :matrix] # The cadence to bill for this price on. # @@ -1591,11 +1588,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice#matrix_config @@ -1623,14 +1617,12 @@ class MatrixConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param default_unit_amount [String] - # # @param dimensions [Array] - # # @param matrix_values [Array] - # # - # def initialize(default_unit_amount:, dimensions:, matrix_values:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(default_unit_amount:, dimensions:, matrix_values:) + # @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value + # + # @param dimensions [Array] One or two event property values to evaluate matrix groups by + # + # @param matrix_values [Array] Matrix values for specified matrix grouping keys class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values @@ -1647,13 +1639,15 @@ class MatrixValue < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param dimension_values [Array] - # # @param unit_amount [String] - # # - # def initialize(dimension_values:, unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, unit_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue} + # for more details. + # + # @param dimension_values [Array] One or two matrix keys to filter usage to this Matrix value by. For example, ["r + # ... + # + # @param unit_amount [String] Unit price for the specified dimension_values end end @@ -1672,16 +1666,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1692,11 +1683,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1715,16 +1703,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -1735,11 +1720,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1854,47 +1836,50 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered] # The cadence to bill for this price on. # @@ -1909,11 +1894,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice#tiered_config @@ -1929,12 +1911,8 @@ class TieredConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Tiers for rating based on total usage quantities into the specified tier class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit @@ -1955,14 +1933,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :last_unit, Float, nil?: true - # @!parse - # # @param first_unit [Float] - # # @param unit_amount [String] - # # @param last_unit [Float, nil] - # # - # def initialize(first_unit:, unit_amount:, last_unit: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(first_unit:, unit_amount:, last_unit: nil) + # @param first_unit [Float] Exclusive tier starting value + # + # @param unit_amount [String] Amount per unit + # + # @param last_unit [Float, nil] Inclusive tier ending value. If null, this is treated as the last tier end end @@ -1981,16 +1957,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2001,11 +1974,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2024,16 +1994,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2044,11 +2011,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2163,47 +2127,50 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_bps_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_bps] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_bps_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_bps_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_bps] # The cadence to bill for this price on. # @@ -2218,11 +2185,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice#tiered_bps_config @@ -2239,12 +2203,13 @@ class TieredBpsConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig} + # for more details. + # + # @param tiers [Array] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -2271,15 +2236,14 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param minimum_amount [String] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Per-event basis point rate + # + # @param minimum_amount [String] Exclusive tier starting value + # + # @param maximum_amount [String, nil] Inclusive tier ending value + # + # @param per_unit_maximum [String, nil] Per unit maximum to charge end end @@ -2298,16 +2262,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2318,11 +2279,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2341,16 +2299,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2361,11 +2316,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2480,47 +2432,50 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bps_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BpsConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bps] - # # - # def initialize( - # bps_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice} + # for more details. + # + # @param bps_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BpsConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bps] # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice#bps_config class BpsConfig < Orb::Internal::Type::BaseModel @@ -2536,13 +2491,10 @@ class BpsConfig < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, per_unit_maximum: nil) + # @param bps [Float] Basis point take rate per event + # + # @param per_unit_maximum [String, nil] Optional currency amount maximum to cap spend per event end # The cadence to bill for this price on. @@ -2558,11 +2510,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice#billing_cycle_configuration @@ -2580,16 +2529,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2600,11 +2546,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2623,16 +2566,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2643,11 +2583,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2762,47 +2699,50 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bulk_bps_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bulk_bps] - # # - # def initialize( - # bulk_bps_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bulk_bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bulk_bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice} + # for more details. + # + # @param bulk_bps_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bulk_bps] # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice#bulk_bps_config class BulkBpsConfig < Orb::Internal::Type::BaseModel @@ -2818,12 +2758,13 @@ class BulkBpsConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig} + # for more details. + # + # @param tiers [Array] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -2844,14 +2785,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Basis points to rate on + # + # @param maximum_amount [String, nil] Upper bound for tier + # + # @param per_unit_maximum [String, nil] The maximum amount to charge for any one event end end @@ -2868,11 +2807,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice#billing_cycle_configuration @@ -2890,16 +2826,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2910,11 +2843,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2933,16 +2863,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -2953,11 +2880,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3072,47 +2996,50 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bulk_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bulk] - # # - # def initialize( - # bulk_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bulk, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bulk) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice} + # for more details. + # + # @param bulk_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bulk] # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice#bulk_config class BulkConfig < Orb::Internal::Type::BaseModel @@ -3127,12 +3054,8 @@ class BulkConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Bulk tiers for rating based on total usage volume class Tier < Orb::Internal::Type::BaseModel # @!attribute unit_amount @@ -3147,13 +3070,10 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :maximum_units, Float, nil?: true - # @!parse - # # @param unit_amount [String] - # # @param maximum_units [Float, nil] - # # - # def initialize(unit_amount:, maximum_units: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:, maximum_units: nil) + # @param unit_amount [String] Amount per unit + # + # @param maximum_units [Float, nil] Upper bound for this tier end end @@ -3170,11 +3090,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice#billing_cycle_configuration @@ -3192,16 +3109,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3212,11 +3126,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3235,16 +3146,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3255,11 +3163,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3373,47 +3278,50 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param threshold_total_amount_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :threshold_total_amount] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # threshold_total_amount_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :threshold_total_amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, threshold_total_amount_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :threshold_total_amount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param threshold_total_amount_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :threshold_total_amount] # The cadence to bill for this price on. # @@ -3428,11 +3336,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice#billing_cycle_configuration @@ -3450,16 +3355,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3470,11 +3372,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3493,16 +3392,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3513,11 +3409,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3631,47 +3524,50 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_package_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_package] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_package_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_package_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_package] # The cadence to bill for this price on. # @@ -3686,11 +3582,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice#billing_cycle_configuration @@ -3708,16 +3601,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3728,11 +3618,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3751,16 +3638,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3771,11 +3655,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3889,47 +3770,50 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_with_minimum_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_with_minimum] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_with_minimum_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_with_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_with_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_with_minimum_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_with_minimum] # The cadence to bill for this price on. # @@ -3944,11 +3828,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice#billing_cycle_configuration @@ -3966,16 +3847,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -3986,11 +3864,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4009,16 +3884,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4029,11 +3901,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4147,47 +4016,50 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_with_percent_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :unit_with_percent] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_with_percent_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :unit_with_percent, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :unit_with_percent) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_with_percent_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :unit_with_percent] # The cadence to bill for this price on. # @@ -4202,11 +4074,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice#billing_cycle_configuration @@ -4224,16 +4093,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4244,11 +4110,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4267,16 +4130,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4287,11 +4147,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4406,47 +4263,50 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param package_with_allocation_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :package_with_allocation] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # package_with_allocation_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :package_with_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, package_with_allocation_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :package_with_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param package_with_allocation_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :package_with_allocation] # The cadence to bill for this price on. # @@ -4461,11 +4321,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice#billing_cycle_configuration @@ -4483,16 +4340,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4503,11 +4357,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4526,16 +4377,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4546,11 +4394,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4661,50 +4506,53 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # A transient ID that can be used to reference this price when adding adjustments # in the same API call. # - # @return [String, nil] - optional :reference_id, String, nil?: true - - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_with_proration_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_with_proration] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_with_proration_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @return [String, nil] + optional :reference_id, String, nil?: true + + # @!method initialize(cadence:, item_id:, name:, tiered_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_with_proration_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_with_proration] # The cadence to bill for this price on. # @@ -4719,11 +4567,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice#billing_cycle_configuration @@ -4741,16 +4586,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4761,11 +4603,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4784,16 +4623,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -4804,11 +4640,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4922,47 +4755,50 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_with_proration_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :unit_with_proration] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_with_proration_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :unit_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :unit_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_with_proration_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :unit_with_proration] # The cadence to bill for this price on. # @@ -4977,11 +4813,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice#billing_cycle_configuration @@ -4999,16 +4832,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5019,11 +4849,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5042,16 +4869,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5062,11 +4886,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5180,47 +5001,50 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence] - # # @param grouped_allocation_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_allocation] - # # - # def initialize( - # cadence:, - # grouped_allocation_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_allocation_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_allocation_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_allocation] # The cadence to bill for this price on. # @@ -5235,11 +5059,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice#billing_cycle_configuration @@ -5257,16 +5078,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5277,11 +5095,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5300,16 +5115,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5320,11 +5132,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5439,47 +5248,50 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence] - # # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_with_prorated_minimum] - # # - # def initialize( - # cadence:, - # grouped_with_prorated_minimum_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_with_prorated_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_with_prorated_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_with_prorated_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_with_prorated_minimum] # The cadence to bill for this price on. # @@ -5494,11 +5306,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#billing_cycle_configuration @@ -5516,16 +5325,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5536,11 +5342,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5559,16 +5362,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5579,11 +5379,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5697,47 +5494,50 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bulk_with_proration_config [Hash{Symbol=>Object}] - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bulk_with_proration] - # # - # def initialize( - # bulk_with_proration_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bulk_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_with_proration_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bulk_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice} + # for more details. + # + # @param bulk_with_proration_config [Hash{Symbol=>Object}] + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bulk_with_proration] # The cadence to bill for this price on. # @@ -5752,11 +5552,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice#billing_cycle_configuration @@ -5774,16 +5571,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5794,11 +5588,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5817,16 +5608,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -5837,11 +5625,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5956,47 +5741,50 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :scalable_matrix_with_unit_pricing] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # scalable_matrix_with_unit_pricing_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :scalable_matrix_with_unit_pricing, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_unit_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_unit_pricing) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :scalable_matrix_with_unit_pricing] # The cadence to bill for this price on. # @@ -6011,11 +5799,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#billing_cycle_configuration @@ -6033,16 +5818,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6053,11 +5835,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6076,16 +5855,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6096,11 +5872,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6215,47 +5988,50 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :scalable_matrix_with_tiered_pricing] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # scalable_matrix_with_tiered_pricing_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :scalable_matrix_with_tiered_pricing, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_tiered_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_tiered_pricing) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :scalable_matrix_with_tiered_pricing] # The cadence to bill for this price on. # @@ -6270,11 +6046,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#billing_cycle_configuration @@ -6292,16 +6065,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6312,11 +6082,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6335,16 +6102,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6355,11 +6119,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6474,47 +6235,50 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence] - # # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :cumulative_grouped_bulk] - # # - # def initialize( - # cadence:, - # cumulative_grouped_bulk_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :cumulative_grouped_bulk, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, cumulative_grouped_bulk_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :cumulative_grouped_bulk) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence] The cadence to bill for this price on. + # + # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :cumulative_grouped_bulk] # The cadence to bill for this price on. # @@ -6529,11 +6293,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#billing_cycle_configuration @@ -6551,16 +6312,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6571,11 +6329,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6594,16 +6349,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6614,11 +6366,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6733,47 +6482,50 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence] - # # @param item_id [String] - # # @param max_group_tiered_package_config [Hash{Symbol=>Object}] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :max_group_tiered_package] - # # - # def initialize( - # cadence:, - # item_id:, - # max_group_tiered_package_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :max_group_tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, max_group_tiered_package_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :max_group_tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param max_group_tiered_package_config [Hash{Symbol=>Object}] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :max_group_tiered_package] # The cadence to bill for this price on. # @@ -6788,11 +6540,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#billing_cycle_configuration @@ -6810,16 +6559,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6830,11 +6576,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6853,16 +6596,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -6873,11 +6613,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6992,47 +6729,50 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence] - # # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_with_metered_minimum] - # # - # def initialize( - # cadence:, - # grouped_with_metered_minimum_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_with_metered_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_with_metered_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_with_metered_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_with_metered_minimum] # The cadence to bill for this price on. # @@ -7047,11 +6787,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#billing_cycle_configuration @@ -7069,16 +6806,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7089,11 +6823,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7112,16 +6843,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7132,11 +6860,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -7241,57 +6966,60 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # by setting the value to `null`, and the entire metadata mapping can be cleared # by setting `metadata` to `null`. # - # @return [Hash{Symbol=>String, nil}, nil] - optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true - - # @!attribute reference_id - # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # @return [Hash{Symbol=>String, nil}, nil] + optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true + + # @!attribute reference_id + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. + # + # @return [String, nil] + optional :reference_id, String, nil?: true + + # @!method initialize(cadence:, item_id:, matrix_with_display_name_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :matrix_with_display_name) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param matrix_with_display_name_config [Hash{Symbol=>Object}] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... # - # @return [String, nil] - optional :reference_id, String, nil?: true - - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence] - # # @param item_id [String] - # # @param matrix_with_display_name_config [Hash{Symbol=>Object}] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :matrix_with_display_name] - # # - # def initialize( - # cadence:, - # item_id:, - # matrix_with_display_name_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :matrix_with_display_name, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :matrix_with_display_name] # The cadence to bill for this price on. # @@ -7306,11 +7034,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#billing_cycle_configuration @@ -7328,16 +7053,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7348,11 +7070,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7371,16 +7090,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7391,11 +7107,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -7509,47 +7222,50 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence] - # # @param grouped_tiered_package_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_tiered_package] - # # - # def initialize( - # cadence:, - # grouped_tiered_package_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_tiered_package_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_tiered_package_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_tiered_package] # The cadence to bill for this price on. # @@ -7564,11 +7280,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice#billing_cycle_configuration @@ -7586,16 +7299,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7606,11 +7316,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -7629,16 +7336,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -7649,18 +7353,14 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end - # @!parse - # # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice)] end end @@ -7674,11 +7374,8 @@ module BillingCycleAlignment PLAN_CHANGE_DATE = :plan_change_date START_OF_MONTH = :start_of_month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel @@ -7706,14 +7403,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAnchorConfiguration} + # for more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end class RemoveAdjustment < Orb::Internal::Type::BaseModel @@ -7723,12 +7425,8 @@ class RemoveAdjustment < Orb::Internal::Type::BaseModel # @return [String] required :adjustment_id, String - # @!parse - # # @param adjustment_id [String] - # # - # def initialize(adjustment_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(adjustment_id:) + # @param adjustment_id [String] The id of the adjustment to remove on the subscription. end class RemovePrice < Orb::Internal::Type::BaseModel @@ -7744,13 +7442,10 @@ class RemovePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :price_id, String, nil?: true - # @!parse - # # @param external_price_id [String, nil] - # # @param price_id [String, nil] - # # - # def initialize(external_price_id: nil, price_id: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(external_price_id: nil, price_id: nil) + # @param external_price_id [String, nil] The external price id of the price to remove on the subscription. + # + # @param price_id [String, nil] The id of the price to remove on the subscription. end class ReplaceAdjustment < Orb::Internal::Type::BaseModel @@ -7767,13 +7462,10 @@ class ReplaceAdjustment < Orb::Internal::Type::BaseModel # @return [String] required :replaces_adjustment_id, String - # @!parse - # # @param adjustment [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewMaximum] - # # @param replaces_adjustment_id [String] - # # - # def initialize(adjustment:, replaces_adjustment_id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(adjustment:, replaces_adjustment_id:) + # @param adjustment [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewMaximum] The definition of a new adjustment to create and add to the subscription. + # + # @param replaces_adjustment_id [String] The id of the adjustment on the plan to replace in the subscription. # The definition of a new adjustment to create and add to the subscription. # @@ -7815,34 +7507,26 @@ class NewPercentageDiscount < Orb::Internal::Type::BaseModel # @return [Float] required :percentage_discount, Float - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param percentage_discount [Float] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # applies_to_price_ids:, - # percentage_discount:, - # is_invoice_level: nil, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, percentage_discount:, is_invoice_level: nil, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewPercentageDiscount} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param percentage_discount [Float] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :percentage_discount] end class NewUsageDiscount < Orb::Internal::Type::BaseModel @@ -7862,26 +7546,26 @@ class NewUsageDiscount < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param usage_discount [Float] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize(applies_to_price_ids:, usage_discount:, is_invoice_level: nil, adjustment_type: :usage_discount, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, usage_discount:, is_invoice_level: nil, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewUsageDiscount} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param usage_discount [Float] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class NewAmountDiscount < Orb::Internal::Type::BaseModel @@ -7901,26 +7585,26 @@ class NewAmountDiscount < Orb::Internal::Type::BaseModel # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize(amount_discount:, applies_to_price_ids:, is_invoice_level: nil, adjustment_type: :amount_discount, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, is_invoice_level: nil, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewAmountDiscount} + # for more details. + # + # @param amount_discount [String] + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :amount_discount] end class NewMinimum < Orb::Internal::Type::BaseModel @@ -7946,27 +7630,28 @@ class NewMinimum < Orb::Internal::Type::BaseModel # @return [String] required :minimum_amount, String - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize(applies_to_price_ids:, item_id:, minimum_amount:, is_invoice_level: nil, adjustment_type: :minimum, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, item_id:, minimum_amount:, is_invoice_level: nil, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewMinimum} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :minimum] end class NewMaximum < Orb::Internal::Type::BaseModel @@ -7986,31 +7671,30 @@ class NewMaximum < Orb::Internal::Type::BaseModel # @return [String] required :maximum_amount, String - # @!attribute [r] is_invoice_level + # @!attribute is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :is_invoice_level - - # @!parse - # # @param applies_to_price_ids [Array] - # # @param maximum_amount [String] - # # @param is_invoice_level [Boolean] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize(applies_to_price_ids:, maximum_amount:, is_invoice_level: nil, adjustment_type: :maximum, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, maximum_amount:, is_invoice_level: nil, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewMaximum} + # for more details. + # + # @param applies_to_price_ids [Array] The set of price IDs to which this adjustment applies. + # + # @param maximum_amount [String] + # + # @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil + # ... + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewMaximum)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewMaximum)] end end @@ -8030,6 +7714,8 @@ class ReplacePrice < Orb::Internal::Type::BaseModel nil?: true # @!attribute discounts + # @deprecated + # # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for the # replacement price. # @@ -8051,6 +7737,8 @@ class ReplacePrice < Orb::Internal::Type::BaseModel optional :fixed_price_quantity, Float, nil?: true # @!attribute maximum_amount + # @deprecated + # # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for # the replacement price. # @@ -8058,6 +7746,8 @@ class ReplacePrice < Orb::Internal::Type::BaseModel optional :maximum_amount, String, nil?: true # @!attribute minimum_amount + # @deprecated + # # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for # the replacement price. # @@ -8078,33 +7768,31 @@ class ReplacePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :price_id, String, nil?: true - # @!parse - # # @param replaces_price_id [String] - # # @param allocation_price [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice, nil] - # # @param discounts [Array, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param maximum_amount [String, nil] - # # @param minimum_amount [String, nil] - # # @param price [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice, nil] - # # @param price_id [String, nil] - # # - # def initialize( - # replaces_price_id:, - # allocation_price: nil, - # discounts: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # maximum_amount: nil, - # minimum_amount: nil, - # price: nil, - # price_id: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(replaces_price_id:, allocation_price: nil, discounts: nil, external_price_id: nil, fixed_price_quantity: nil, maximum_amount: nil, minimum_amount: nil, price: nil, price_id: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice} for more + # details. + # + # @param replaces_price_id [String] The id of the price on the plan to replace in the subscription. + # + # @param allocation_price [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice, nil] The definition of a new allocation price to create and add to the subscription. + # + # @param discounts [Array, nil] [DEPRECATED] Use add_adjustments instead. The subscription's discounts for the r + # ... + # + # @param external_price_id [String, nil] The external price id of the price to add to the subscription. + # + # @param fixed_price_quantity [Float, nil] The new quantity of the price, if the price is a fixed price. + # + # @param maximum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for + # ... + # + # @param minimum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for + # ... + # + # @param price [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice, nil] The definition of a new price to create and add to the subscription. + # + # @param price_id [String, nil] The id of the price to add to the subscription. # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice#allocation_price class AllocationPrice < Orb::Internal::Type::BaseModel @@ -8135,17 +7823,22 @@ class AllocationPrice < Orb::Internal::Type::BaseModel # @return [Boolean] required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean - # @!parse - # # The definition of a new allocation price to create and add to the subscription. - # # - # # @param amount [String] - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::Cadence] - # # @param currency [String] - # # @param expires_at_end_of_cadence [Boolean] - # # - # def initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice} + # for more details. + # + # The definition of a new allocation price to create and add to the subscription. + # + # @param amount [String] An amount of the currency to allocate to the customer at the specified cadence. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::Cadence] The cadence at which to allocate the amount to the customer. + # + # @param currency [String] An ISO 4217 currency string or a custom pricing unit identifier in which to bill + # ... + # + # @param expires_at_end_of_cadence [Boolean] Whether the allocated amount should expire at the end of the cadence or roll ove + # ... # The cadence at which to allocate the amount to the customer. # @@ -8160,11 +7853,8 @@ module Cadence ANNUAL = :annual CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -8195,15 +7885,20 @@ class Discount < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :usage_discount, Float, nil?: true - # @!parse - # # @param discount_type [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Discount::DiscountType] - # # @param amount_discount [String, nil] - # # @param percentage_discount [Float, nil] - # # @param usage_discount [Float, nil] - # # - # def initialize(discount_type:, amount_discount: nil, percentage_discount: nil, usage_discount: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(discount_type:, amount_discount: nil, percentage_discount: nil, usage_discount: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Discount} for + # more details. + # + # @param discount_type [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Discount::DiscountType] + # + # @param amount_discount [String, nil] Only available if discount_type is `amount`. + # + # @param percentage_discount [Float, nil] Only available if discount_type is `percentage`. This is a number between 0 and + # ... + # + # @param usage_discount [Float, nil] Only available if discount_type is `usage`. Number of usage units that this disc + # ... # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Discount#discount_type module DiscountType @@ -8213,11 +7908,8 @@ module DiscountType USAGE = :usage AMOUNT = :amount - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -8414,47 +8106,50 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::UnitConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :unit] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :unit, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :unit) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::UnitConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :unit] # The cadence to bill for this price on. # @@ -8469,11 +8164,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice#unit_config @@ -8484,12 +8176,8 @@ class UnitConfig < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param unit_amount [String] - # # - # def initialize(unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:) + # @param unit_amount [String] Rate per unit of usage end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice#billing_cycle_configuration @@ -8507,16 +8195,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -8527,11 +8212,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -8550,16 +8232,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -8570,11 +8249,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -8689,47 +8365,50 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param package_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::PackageConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :package] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # package_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param package_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::PackageConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :package] # The cadence to bill for this price on. # @@ -8744,11 +8423,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice#package_config @@ -8766,13 +8442,15 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @return [Integer] required :package_size, Integer - # @!parse - # # @param package_amount [String] - # # @param package_size [Integer] - # # - # def initialize(package_amount:, package_size:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(package_amount:, package_size:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::PackageConfig} + # for more details. + # + # @param package_amount [String] A currency amount to rate usage by + # + # @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide + # ... end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice#billing_cycle_configuration @@ -8790,16 +8468,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -8810,11 +8485,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -8833,16 +8505,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -8853,11 +8522,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -8972,47 +8638,50 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence] - # # @param item_id [String] - # # @param matrix_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :matrix] - # # - # def initialize( - # cadence:, - # item_id:, - # matrix_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :matrix, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, matrix_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :matrix) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param matrix_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :matrix] # The cadence to bill for this price on. # @@ -9027,11 +8696,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice#matrix_config @@ -9059,14 +8725,12 @@ class MatrixConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param default_unit_amount [String] - # # @param dimensions [Array] - # # @param matrix_values [Array] - # # - # def initialize(default_unit_amount:, dimensions:, matrix_values:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(default_unit_amount:, dimensions:, matrix_values:) + # @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value + # + # @param dimensions [Array] One or two event property values to evaluate matrix groups by + # + # @param matrix_values [Array] Matrix values for specified matrix grouping keys class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values @@ -9083,13 +8747,15 @@ class MatrixValue < Orb::Internal::Type::BaseModel # @return [String] required :unit_amount, String - # @!parse - # # @param dimension_values [Array] - # # @param unit_amount [String] - # # - # def initialize(dimension_values:, unit_amount:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(dimension_values:, unit_amount:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue} + # for more details. + # + # @param dimension_values [Array] One or two matrix keys to filter usage to this Matrix value by. For example, ["r + # ... + # + # @param unit_amount [String] Unit price for the specified dimension_values end end @@ -9108,16 +8774,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -9128,11 +8791,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -9151,16 +8811,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -9171,11 +8828,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -9290,47 +8944,50 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered] # The cadence to bill for this price on. # @@ -9345,11 +9002,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice#tiered_config @@ -9365,12 +9019,8 @@ class TieredConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Tiers for rating based on total usage quantities into the specified tier class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit @@ -9391,14 +9041,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :last_unit, Float, nil?: true - # @!parse - # # @param first_unit [Float] - # # @param unit_amount [String] - # # @param last_unit [Float, nil] - # # - # def initialize(first_unit:, unit_amount:, last_unit: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(first_unit:, unit_amount:, last_unit: nil) + # @param first_unit [Float] Exclusive tier starting value + # + # @param unit_amount [String] Amount per unit + # + # @param last_unit [Float, nil] Inclusive tier ending value. If null, this is treated as the last tier end end @@ -9417,16 +9065,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -9437,11 +9082,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -9460,16 +9102,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -9480,11 +9119,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -9599,47 +9235,50 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_bps_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_bps] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_bps_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_bps_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_bps] # The cadence to bill for this price on. # @@ -9654,11 +9293,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice#tiered_bps_config @@ -9675,12 +9311,13 @@ class TieredBpsConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig} + # for more details. + # + # @param tiers [Array] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -9707,15 +9344,14 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param minimum_amount [String] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Per-event basis point rate + # + # @param minimum_amount [String] Exclusive tier starting value + # + # @param maximum_amount [String, nil] Inclusive tier ending value + # + # @param per_unit_maximum [String, nil] Per unit maximum to charge end end @@ -9734,16 +9370,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -9754,11 +9387,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -9777,16 +9407,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -9797,11 +9424,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -9916,47 +9540,50 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bps_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BpsConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bps] - # # - # def initialize( - # bps_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice} + # for more details. + # + # @param bps_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BpsConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bps] # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice#bps_config class BpsConfig < Orb::Internal::Type::BaseModel @@ -9972,13 +9599,10 @@ class BpsConfig < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, per_unit_maximum: nil) + # @param bps [Float] Basis point take rate per event + # + # @param per_unit_maximum [String, nil] Optional currency amount maximum to cap spend per event end # The cadence to bill for this price on. @@ -9994,11 +9618,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice#billing_cycle_configuration @@ -10016,16 +9637,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10036,11 +9654,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -10059,16 +9674,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10079,11 +9691,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -10198,47 +9807,50 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bulk_bps_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bulk_bps] - # # - # def initialize( - # bulk_bps_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bulk_bps, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bulk_bps) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice} + # for more details. + # + # @param bulk_bps_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bulk_bps] # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice#bulk_bps_config class BulkBpsConfig < Orb::Internal::Type::BaseModel @@ -10254,12 +9866,13 @@ class BulkBpsConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig} + # for more details. + # + # @param tiers [Array] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie + # ... class Tier < Orb::Internal::Type::BaseModel # @!attribute bps @@ -10280,14 +9893,12 @@ class Tier < Orb::Internal::Type::BaseModel # @return [String, nil] optional :per_unit_maximum, String, nil?: true - # @!parse - # # @param bps [Float] - # # @param maximum_amount [String, nil] - # # @param per_unit_maximum [String, nil] - # # - # def initialize(bps:, maximum_amount: nil, per_unit_maximum: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bps:, maximum_amount: nil, per_unit_maximum: nil) + # @param bps [Float] Basis points to rate on + # + # @param maximum_amount [String, nil] Upper bound for tier + # + # @param per_unit_maximum [String, nil] The maximum amount to charge for any one event end end @@ -10304,11 +9915,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice#billing_cycle_configuration @@ -10326,16 +9934,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10346,11 +9951,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -10369,16 +9971,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10389,11 +9988,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -10508,47 +10104,50 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bulk_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig] - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bulk] - # # - # def initialize( - # bulk_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bulk, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bulk) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice} + # for more details. + # + # @param bulk_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig] + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bulk] # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice#bulk_config class BulkConfig < Orb::Internal::Type::BaseModel @@ -10563,12 +10162,8 @@ class BulkConfig < Orb::Internal::Type::BaseModel ] end - # @!parse - # # @param tiers [Array] - # # - # def initialize(tiers:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(tiers:) + # @param tiers [Array] Bulk tiers for rating based on total usage volume class Tier < Orb::Internal::Type::BaseModel # @!attribute unit_amount @@ -10583,13 +10178,10 @@ class Tier < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :maximum_units, Float, nil?: true - # @!parse - # # @param unit_amount [String] - # # @param maximum_units [Float, nil] - # # - # def initialize(unit_amount:, maximum_units: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(unit_amount:, maximum_units: nil) + # @param unit_amount [String] Amount per unit + # + # @param maximum_units [Float, nil] Upper bound for this tier end end @@ -10606,11 +10198,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice#billing_cycle_configuration @@ -10628,16 +10217,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10648,11 +10234,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -10671,16 +10254,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10691,11 +10271,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -10809,47 +10386,50 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param threshold_total_amount_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :threshold_total_amount] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # threshold_total_amount_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :threshold_total_amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, threshold_total_amount_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :threshold_total_amount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param threshold_total_amount_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :threshold_total_amount] # The cadence to bill for this price on. # @@ -10864,11 +10444,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice#billing_cycle_configuration @@ -10886,16 +10463,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10906,11 +10480,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -10929,16 +10500,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -10949,11 +10517,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -11067,47 +10632,50 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_package_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_package] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_package_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_package_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_package] # The cadence to bill for this price on. # @@ -11122,11 +10690,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice#billing_cycle_configuration @@ -11144,16 +10709,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11164,11 +10726,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -11187,16 +10746,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11207,11 +10763,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -11325,47 +10878,50 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_with_minimum_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_with_minimum] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_with_minimum_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_with_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_with_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_with_minimum_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_with_minimum] # The cadence to bill for this price on. # @@ -11380,11 +10936,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice#billing_cycle_configuration @@ -11402,16 +10955,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11422,11 +10972,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -11445,16 +10992,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11465,11 +11009,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -11583,47 +11124,50 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_with_percent_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :unit_with_percent] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_with_percent_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :unit_with_percent, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :unit_with_percent) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_with_percent_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :unit_with_percent] # The cadence to bill for this price on. # @@ -11638,11 +11182,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice#billing_cycle_configuration @@ -11660,16 +11201,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11680,11 +11218,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -11703,16 +11238,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11723,11 +11255,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -11842,47 +11371,50 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param package_with_allocation_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :package_with_allocation] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # package_with_allocation_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :package_with_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, package_with_allocation_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :package_with_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param package_with_allocation_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :package_with_allocation] # The cadence to bill for this price on. # @@ -11897,11 +11429,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice#billing_cycle_configuration @@ -11919,16 +11448,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11939,11 +11465,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -11962,16 +11485,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -11982,11 +11502,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -12100,47 +11617,50 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param tiered_with_proration_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :tiered_with_proration] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # tiered_with_proration_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :tiered_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, tiered_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :tiered_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param tiered_with_proration_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :tiered_with_proration] # The cadence to bill for this price on. # @@ -12155,11 +11675,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice#billing_cycle_configuration @@ -12177,16 +11694,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12197,11 +11711,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -12220,16 +11731,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12240,11 +11748,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -12358,47 +11863,50 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param unit_with_proration_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :unit_with_proration] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # unit_with_proration_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :unit_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :unit_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param unit_with_proration_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :unit_with_proration] # The cadence to bill for this price on. # @@ -12413,11 +11921,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice#billing_cycle_configuration @@ -12435,16 +11940,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12455,11 +11957,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -12478,16 +11977,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12498,11 +11994,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -12616,47 +12109,50 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence] - # # @param grouped_allocation_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_allocation] - # # - # def initialize( - # cadence:, - # grouped_allocation_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_allocation, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_allocation_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_allocation) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_allocation_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_allocation] # The cadence to bill for this price on. # @@ -12671,11 +12167,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice#billing_cycle_configuration @@ -12693,16 +12186,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12713,11 +12203,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -12736,16 +12223,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12756,11 +12240,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -12875,47 +12356,50 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence] - # # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_with_prorated_minimum] - # # - # def initialize( - # cadence:, - # grouped_with_prorated_minimum_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_with_prorated_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_with_prorated_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_with_prorated_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_with_prorated_minimum] # The cadence to bill for this price on. # @@ -12930,11 +12414,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#billing_cycle_configuration @@ -12952,16 +12433,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -12972,11 +12450,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -12995,16 +12470,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -13015,11 +12487,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -13133,47 +12602,50 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param bulk_with_proration_config [Hash{Symbol=>Object}] - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :bulk_with_proration] - # # - # def initialize( - # bulk_with_proration_config:, - # cadence:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :bulk_with_proration, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(bulk_with_proration_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :bulk_with_proration) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice} + # for more details. + # + # @param bulk_with_proration_config [Hash{Symbol=>Object}] + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :bulk_with_proration] # The cadence to bill for this price on. # @@ -13188,11 +12660,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice#billing_cycle_configuration @@ -13210,16 +12679,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -13230,11 +12696,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -13253,16 +12716,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -13273,11 +12733,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -13392,47 +12849,50 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :scalable_matrix_with_unit_pricing] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # scalable_matrix_with_unit_pricing_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :scalable_matrix_with_unit_pricing, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_unit_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_unit_pricing) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :scalable_matrix_with_unit_pricing] # The cadence to bill for this price on. # @@ -13447,11 +12907,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#billing_cycle_configuration @@ -13469,16 +12926,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -13489,11 +12943,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -13512,16 +12963,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -13532,11 +12980,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -13651,47 +13096,50 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence] - # # @param item_id [String] - # # @param name [String] - # # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :scalable_matrix_with_tiered_pricing] - # # - # def initialize( - # cadence:, - # item_id:, - # name:, - # scalable_matrix_with_tiered_pricing_config:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :scalable_matrix_with_tiered_pricing, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_tiered_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_tiered_pricing) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :scalable_matrix_with_tiered_pricing] # The cadence to bill for this price on. # @@ -13706,11 +13154,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#billing_cycle_configuration @@ -13728,16 +13173,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -13748,11 +13190,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -13771,16 +13210,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -13791,11 +13227,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -13910,47 +13343,50 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence] - # # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :cumulative_grouped_bulk] - # # - # def initialize( - # cadence:, - # cumulative_grouped_bulk_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :cumulative_grouped_bulk, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, cumulative_grouped_bulk_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :cumulative_grouped_bulk) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence] The cadence to bill for this price on. + # + # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :cumulative_grouped_bulk] # The cadence to bill for this price on. # @@ -13965,11 +13401,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#billing_cycle_configuration @@ -13987,16 +13420,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14007,11 +13437,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -14030,16 +13457,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14050,11 +13474,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -14169,47 +13590,50 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence] - # # @param item_id [String] - # # @param max_group_tiered_package_config [Hash{Symbol=>Object}] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :max_group_tiered_package] - # # - # def initialize( - # cadence:, - # item_id:, - # max_group_tiered_package_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :max_group_tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, max_group_tiered_package_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :max_group_tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param max_group_tiered_package_config [Hash{Symbol=>Object}] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :max_group_tiered_package] # The cadence to bill for this price on. # @@ -14224,11 +13648,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#billing_cycle_configuration @@ -14246,16 +13667,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14266,11 +13684,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -14289,16 +13704,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14309,11 +13721,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -14428,47 +13837,50 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence] - # # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_with_metered_minimum] - # # - # def initialize( - # cadence:, - # grouped_with_metered_minimum_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_with_metered_minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_with_metered_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_with_metered_minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_with_metered_minimum] # The cadence to bill for this price on. # @@ -14483,11 +13895,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#billing_cycle_configuration @@ -14505,16 +13914,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14525,11 +13931,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -14548,16 +13951,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14568,11 +13968,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -14687,47 +14084,50 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence] - # # @param item_id [String] - # # @param matrix_with_display_name_config [Hash{Symbol=>Object}] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :matrix_with_display_name] - # # - # def initialize( - # cadence:, - # item_id:, - # matrix_with_display_name_config:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :matrix_with_display_name, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, item_id:, matrix_with_display_name_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :matrix_with_display_name) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence] The cadence to bill for this price on. + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param matrix_with_display_name_config [Hash{Symbol=>Object}] + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :matrix_with_display_name] # The cadence to bill for this price on. # @@ -14742,11 +14142,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#billing_cycle_configuration @@ -14764,16 +14161,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14784,11 +14178,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -14807,16 +14198,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -14827,11 +14215,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -14945,47 +14330,50 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reference_id, String, nil?: true - # @!parse - # # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence] - # # @param grouped_tiered_package_config [Hash{Symbol=>Object}] - # # @param item_id [String] - # # @param name [String] - # # @param billable_metric_id [String, nil] - # # @param billed_in_advance [Boolean, nil] - # # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration, nil] - # # @param conversion_rate [Float, nil] - # # @param currency [String, nil] - # # @param external_price_id [String, nil] - # # @param fixed_price_quantity [Float, nil] - # # @param invoice_grouping_key [String, nil] - # # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param reference_id [String, nil] - # # @param model_type [Symbol, :grouped_tiered_package] - # # - # def initialize( - # cadence:, - # grouped_tiered_package_config:, - # item_id:, - # name:, - # billable_metric_id: nil, - # billed_in_advance: nil, - # billing_cycle_configuration: nil, - # conversion_rate: nil, - # currency: nil, - # external_price_id: nil, - # fixed_price_quantity: nil, - # invoice_grouping_key: nil, - # invoicing_cycle_configuration: nil, - # metadata: nil, - # reference_id: nil, - # model_type: :grouped_tiered_package, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(cadence:, grouped_tiered_package_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil, model_type: :grouped_tiered_package) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice} + # for more details. + # + # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence] The cadence to bill for this price on. + # + # @param grouped_tiered_package_config [Hash{Symbol=>Object}] + # + # @param item_id [String] The id of the item the price will be associated with. + # + # @param name [String] The name of the price. + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr + # ... + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments + # ... + # + # @param model_type [Symbol, :grouped_tiered_package] # The cadence to bill for this price on. # @@ -15000,11 +14388,8 @@ module Cadence ONE_TIME = :one_time CUSTOM = :custom - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice#billing_cycle_configuration @@ -15022,16 +14407,13 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit } - # @!parse - # # For custom cadence: specifies the duration of the billing period in days or - # # months. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # For custom cadence: specifies the duration of the billing period in days or + # months. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -15042,11 +14424,8 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -15065,16 +14444,13 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel required :duration_unit, enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit } - # @!parse - # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. - # # - # # @param duration [Integer] - # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] - # # - # def initialize(duration:, duration_unit:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(duration:, duration_unit:) + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. + # + # @param duration [Integer] The duration of the billing period. + # + # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration. # The unit of billing period duration. # @@ -15085,18 +14461,14 @@ module DurationUnit DAY = :day MONTH = :month - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end - # @!parse - # # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice)] end end end diff --git a/lib/orb/models/subscription_schedule_plan_change_response.rb b/lib/orb/models/subscription_schedule_plan_change_response.rb index 8c1304f8..e67d0c50 100644 --- a/lib/orb/models/subscription_schedule_plan_change_response.rb +++ b/lib/orb/models/subscription_schedule_plan_change_response.rb @@ -211,69 +211,75 @@ class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources }, nil?: true - # @!parse - # # @param id [String] - # # @param active_plan_phase_order [Integer, nil] - # # @param adjustment_intervals [Array] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration] - # # @param billing_cycle_day [Integer] - # # @param created_at [Time] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param customer [Orb::Models::Customer] - # # @param default_invoice_memo [String, nil] - # # @param discount_intervals [Array] - # # @param end_date [Time, nil] - # # @param fixed_fee_quantity_schedule [Array] - # # @param invoicing_threshold [String, nil] - # # @param maximum_intervals [Array] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum_intervals [Array] - # # @param net_terms [Integer] - # # @param pending_subscription_change [Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange, nil] - # # @param plan [Orb::Models::Plan] - # # @param price_intervals [Array] - # # @param redeemed_coupon [Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon, nil] - # # @param start_date [Time] - # # @param status [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::Status] - # # @param trial_info [Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo] - # # @param changed_resources [Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources, nil] - # # - # def initialize( - # id:, - # active_plan_phase_order:, - # adjustment_intervals:, - # auto_collection:, - # billing_cycle_anchor_configuration:, - # billing_cycle_day:, - # created_at:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # customer:, - # default_invoice_memo:, - # discount_intervals:, - # end_date:, - # fixed_fee_quantity_schedule:, - # invoicing_threshold:, - # maximum_intervals:, - # metadata:, - # minimum_intervals:, - # net_terms:, - # pending_subscription_change:, - # plan:, - # price_intervals:, - # redeemed_coupon:, - # start_date:, - # status:, - # trial_info:, - # changed_resources: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeResponse} for more details. + # + # @param id [String] + # + # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase + # ... + # + # @param adjustment_intervals [Array] The adjustment intervals for this subscription sorted by the start_date of the a + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration] + # + # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param created_at [Time] + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i + # ... + # + # @param discount_intervals [Array] The discount intervals for this subscription sorted by the start_date. + # + # @param end_date [Time, nil] The date Orb stops billing for this subscription. + # + # @param fixed_fee_quantity_schedule [Array] + # + # @param invoicing_threshold [String, nil] + # + # @param maximum_intervals [Array] The maximum intervals for this subscription sorted by the start_date. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum_intervals [Array] The minimum intervals for this subscription sorted by the start_date. + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param pending_subscription_change [Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription. + # + # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # ... + # + # @param price_intervals [Array] The price intervals for this subscription. + # + # @param redeemed_coupon [Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon, nil] + # + # @param start_date [Time] The date Orb starts billing for this subscription. + # + # @param status [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::Status] + # + # @param trial_info [Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo] + # + # @param changed_resources [Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet + # ... class AdjustmentInterval < Orb::Internal::Type::BaseModel # @!attribute id @@ -305,16 +311,16 @@ class AdjustmentInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param id [String] - # # @param adjustment [Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) + # @param id [String] + # + # @param adjustment [Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # + # @param applies_to_price_interval_ids [Array] The price interval IDs that this adjustment applies to. + # + # @param end_date [Time, nil] The end date of the adjustment interval. + # + # @param start_date [Time] The start date of the adjustment interval. # @see Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval#adjustment module Adjustment @@ -380,29 +386,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -448,29 +451,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -516,29 +516,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -590,31 +587,28 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -660,34 +654,30 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] end end @@ -717,14 +707,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration} + # for more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end module DiscountInterval @@ -777,27 +772,18 @@ class AmountDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param discount_type [Symbol, :amount] - # # - # def initialize( - # amount_discount:, - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # discount_type: :amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount) + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -837,27 +823,23 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param percentage_discount [Float] - # # @param start_date [Time] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # percentage_discount:, - # start_date:, - # discount_type: :percentage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1 + # ... + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -897,32 +879,27 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # usage_discount:, - # discount_type: :usage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval)] end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -946,15 +923,11 @@ class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param end_date [Time, nil] - # # @param price_id [String] - # # @param quantity [Float] - # # @param start_date [Time] - # # - # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, price_id:, quantity:, start_date:) + # @param end_date [Time, nil] + # @param price_id [String] + # @param quantity [Float] + # @param start_date [Time] end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -989,16 +962,21 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param maximum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval} for more + # details. + # + # @param applies_to_price_ids [Array] The price ids that this maximum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this maximum interval applies to. + # + # @param end_date [Time, nil] The end date of the maximum interval. + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the maximum interval. end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1033,16 +1011,21 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param minimum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval} for more + # details. + # + # @param applies_to_price_ids [Array] The price ids that this minimum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this minimum interval applies to. + # + # @param end_date [Time, nil] The end date of the minimum interval. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the minimum interval. end # @see Orb::Models::SubscriptionSchedulePlanChangeResponse#pending_subscription_change @@ -1052,14 +1035,10 @@ class PendingSubscriptionChange < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # A pending subscription change if one exists on this subscription. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # A pending subscription change if one exists on this subscription. + # + # @param id [String] end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1141,39 +1120,41 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. - # # - # # @param id [String] - # # @param billing_cycle_day [Integer] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param end_date [Time, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param start_date [Time] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # billing_cycle_day:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # end_date:, - # filter:, - # fixed_fee_quantity_transitions:, - # price:, - # start_date:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval} for more + # details. + # + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + # + # @param id [String] + # + # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. + # + # @param fixed_fee_quantity_transitions [Array, nil] The fixed fee quantity transitions for this price interval. This is only relevan + # ... + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @!attribute effective_date @@ -1191,14 +1172,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param price_id [String] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, price_id:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, price_id:, quantity:) + # @param effective_date [Time] + # @param price_id [String] + # @param quantity [Integer] end end @@ -1219,14 +1196,10 @@ class RedeemedCoupon < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param coupon_id [String] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(coupon_id:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(coupon_id:, end_date:, start_date:) + # @param coupon_id [String] + # @param end_date [Time, nil] + # @param start_date [Time] end # @see Orb::Models::SubscriptionSchedulePlanChangeResponse#status @@ -1237,11 +1210,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionSchedulePlanChangeResponse#trial_info @@ -1251,12 +1221,8 @@ class TrialInfo < Orb::Internal::Type::BaseModel # @return [Time, nil] required :end_date, Time, nil?: true - # @!parse - # # @param end_date [Time, nil] - # # - # def initialize(end_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:) + # @param end_date [Time, nil] end # @see Orb::Models::SubscriptionSchedulePlanChangeResponse#changed_resources @@ -1285,19 +1251,18 @@ class ChangedResources < Orb::Internal::Type::BaseModel # @return [Array] required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } - # @!parse - # # The resources that were changed as part of this operation. Only present when - # # fetched through the subscription changes API or if the - # # `include_changed_resources` parameter was passed in the request. - # # - # # @param created_credit_notes [Array] - # # @param created_invoices [Array] - # # @param voided_credit_notes [Array] - # # @param voided_invoices [Array] - # # - # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:) + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @param created_credit_notes [Array] The credit notes that were created as part of this operation. + # + # @param created_invoices [Array] The invoices that were created as part of this operation. + # + # @param voided_credit_notes [Array] The credit notes that were voided as part of this operation. + # + # @param voided_invoices [Array] The invoices that were voided as part of this operation. end end end diff --git a/lib/orb/models/subscription_trigger_phase_params.rb b/lib/orb/models/subscription_trigger_phase_params.rb index 166abf03..34686a07 100644 --- a/lib/orb/models/subscription_trigger_phase_params.rb +++ b/lib/orb/models/subscription_trigger_phase_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Subscriptions#trigger_phase class SubscriptionTriggerPhaseParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute allow_invoice_credit_or_void @@ -23,14 +22,17 @@ class SubscriptionTriggerPhaseParams < Orb::Internal::Type::BaseModel # @return [Date, nil] optional :effective_date, Date, nil?: true - # @!parse - # # @param allow_invoice_credit_or_void [Boolean, nil] - # # @param effective_date [Date, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(allow_invoice_credit_or_void: nil, effective_date: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(allow_invoice_credit_or_void: nil, effective_date: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionTriggerPhaseParams} for more details. + # + # @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a + # ... + # + # @param effective_date [Date, nil] The date on which the phase change should take effect. If not provided, defaults + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/subscription_trigger_phase_response.rb b/lib/orb/models/subscription_trigger_phase_response.rb index 57c6cc0d..c8a43ad3 100644 --- a/lib/orb/models/subscription_trigger_phase_response.rb +++ b/lib/orb/models/subscription_trigger_phase_response.rb @@ -211,69 +211,75 @@ class SubscriptionTriggerPhaseResponse < Orb::Internal::Type::BaseModel -> { Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources }, nil?: true - # @!parse - # # @param id [String] - # # @param active_plan_phase_order [Integer, nil] - # # @param adjustment_intervals [Array] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionTriggerPhaseResponse::BillingCycleAnchorConfiguration] - # # @param billing_cycle_day [Integer] - # # @param created_at [Time] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param customer [Orb::Models::Customer] - # # @param default_invoice_memo [String, nil] - # # @param discount_intervals [Array] - # # @param end_date [Time, nil] - # # @param fixed_fee_quantity_schedule [Array] - # # @param invoicing_threshold [String, nil] - # # @param maximum_intervals [Array] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum_intervals [Array] - # # @param net_terms [Integer] - # # @param pending_subscription_change [Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange, nil] - # # @param plan [Orb::Models::Plan] - # # @param price_intervals [Array] - # # @param redeemed_coupon [Orb::Models::SubscriptionTriggerPhaseResponse::RedeemedCoupon, nil] - # # @param start_date [Time] - # # @param status [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::Status] - # # @param trial_info [Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo] - # # @param changed_resources [Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources, nil] - # # - # def initialize( - # id:, - # active_plan_phase_order:, - # adjustment_intervals:, - # auto_collection:, - # billing_cycle_anchor_configuration:, - # billing_cycle_day:, - # created_at:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # customer:, - # default_invoice_memo:, - # discount_intervals:, - # end_date:, - # fixed_fee_quantity_schedule:, - # invoicing_threshold:, - # maximum_intervals:, - # metadata:, - # minimum_intervals:, - # net_terms:, - # pending_subscription_change:, - # plan:, - # price_intervals:, - # redeemed_coupon:, - # start_date:, - # status:, - # trial_info:, - # changed_resources: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionTriggerPhaseResponse} for more details. + # + # @param id [String] + # + # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase + # ... + # + # @param adjustment_intervals [Array] The adjustment intervals for this subscription sorted by the start_date of the a + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionTriggerPhaseResponse::BillingCycleAnchorConfiguration] + # + # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param created_at [Time] + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i + # ... + # + # @param discount_intervals [Array] The discount intervals for this subscription sorted by the start_date. + # + # @param end_date [Time, nil] The date Orb stops billing for this subscription. + # + # @param fixed_fee_quantity_schedule [Array] + # + # @param invoicing_threshold [String, nil] + # + # @param maximum_intervals [Array] The maximum intervals for this subscription sorted by the start_date. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum_intervals [Array] The minimum intervals for this subscription sorted by the start_date. + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param pending_subscription_change [Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription. + # + # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # ... + # + # @param price_intervals [Array] The price intervals for this subscription. + # + # @param redeemed_coupon [Orb::Models::SubscriptionTriggerPhaseResponse::RedeemedCoupon, nil] + # + # @param start_date [Time] The date Orb starts billing for this subscription. + # + # @param status [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::Status] + # + # @param trial_info [Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo] + # + # @param changed_resources [Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet + # ... class AdjustmentInterval < Orb::Internal::Type::BaseModel # @!attribute id @@ -305,16 +311,16 @@ class AdjustmentInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param id [String] - # # @param adjustment [Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) + # @param id [String] + # + # @param adjustment [Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # + # @param applies_to_price_interval_ids [Array] The price interval IDs that this adjustment applies to. + # + # @param end_date [Time, nil] The end date of the adjustment interval. + # + # @param start_date [Time] The start date of the adjustment interval. # @see Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval#adjustment module Adjustment @@ -380,29 +386,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -448,29 +451,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -516,29 +516,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -590,31 +587,28 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -660,34 +654,30 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] end end @@ -717,14 +707,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionTriggerPhaseResponse::BillingCycleAnchorConfiguration} + # for more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end module DiscountInterval @@ -777,27 +772,18 @@ class AmountDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param discount_type [Symbol, :amount] - # # - # def initialize( - # amount_discount:, - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # discount_type: :amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount) + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -837,27 +823,23 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param percentage_discount [Float] - # # @param start_date [Time] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # percentage_discount:, - # start_date:, - # discount_type: :percentage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1 + # ... + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -897,32 +879,27 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # usage_discount:, - # discount_type: :usage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval)] end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -946,15 +923,11 @@ class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param end_date [Time, nil] - # # @param price_id [String] - # # @param quantity [Float] - # # @param start_date [Time] - # # - # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, price_id:, quantity:, start_date:) + # @param end_date [Time, nil] + # @param price_id [String] + # @param quantity [Float] + # @param start_date [Time] end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -989,16 +962,21 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param maximum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval} for more + # details. + # + # @param applies_to_price_ids [Array] The price ids that this maximum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this maximum interval applies to. + # + # @param end_date [Time, nil] The end date of the maximum interval. + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the maximum interval. end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1033,16 +1011,21 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param minimum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval} for more + # details. + # + # @param applies_to_price_ids [Array] The price ids that this minimum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this minimum interval applies to. + # + # @param end_date [Time, nil] The end date of the minimum interval. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the minimum interval. end # @see Orb::Models::SubscriptionTriggerPhaseResponse#pending_subscription_change @@ -1052,14 +1035,10 @@ class PendingSubscriptionChange < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # A pending subscription change if one exists on this subscription. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # A pending subscription change if one exists on this subscription. + # + # @param id [String] end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1141,39 +1120,40 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. - # # - # # @param id [String] - # # @param billing_cycle_day [Integer] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param end_date [Time, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param start_date [Time] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # billing_cycle_day:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # end_date:, - # filter:, - # fixed_fee_quantity_transitions:, - # price:, - # start_date:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval} for more details. + # + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + # + # @param id [String] + # + # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. + # + # @param fixed_fee_quantity_transitions [Array, nil] The fixed fee quantity transitions for this price interval. This is only relevan + # ... + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @!attribute effective_date @@ -1191,14 +1171,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param price_id [String] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, price_id:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, price_id:, quantity:) + # @param effective_date [Time] + # @param price_id [String] + # @param quantity [Integer] end end @@ -1219,14 +1195,10 @@ class RedeemedCoupon < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param coupon_id [String] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(coupon_id:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(coupon_id:, end_date:, start_date:) + # @param coupon_id [String] + # @param end_date [Time, nil] + # @param start_date [Time] end # @see Orb::Models::SubscriptionTriggerPhaseResponse#status @@ -1237,11 +1209,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionTriggerPhaseResponse#trial_info @@ -1251,12 +1220,8 @@ class TrialInfo < Orb::Internal::Type::BaseModel # @return [Time, nil] required :end_date, Time, nil?: true - # @!parse - # # @param end_date [Time, nil] - # # - # def initialize(end_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:) + # @param end_date [Time, nil] end # @see Orb::Models::SubscriptionTriggerPhaseResponse#changed_resources @@ -1285,19 +1250,18 @@ class ChangedResources < Orb::Internal::Type::BaseModel # @return [Array] required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } - # @!parse - # # The resources that were changed as part of this operation. Only present when - # # fetched through the subscription changes API or if the - # # `include_changed_resources` parameter was passed in the request. - # # - # # @param created_credit_notes [Array] - # # @param created_invoices [Array] - # # @param voided_credit_notes [Array] - # # @param voided_invoices [Array] - # # - # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:) + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @param created_credit_notes [Array] The credit notes that were created as part of this operation. + # + # @param created_invoices [Array] The invoices that were created as part of this operation. + # + # @param voided_credit_notes [Array] The credit notes that were voided as part of this operation. + # + # @param voided_invoices [Array] The invoices that were voided as part of this operation. end end end diff --git a/lib/orb/models/subscription_unschedule_cancellation_params.rb b/lib/orb/models/subscription_unschedule_cancellation_params.rb index 3902d7e9..3e333bf0 100644 --- a/lib/orb/models/subscription_unschedule_cancellation_params.rb +++ b/lib/orb/models/subscription_unschedule_cancellation_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Subscriptions#unschedule_cancellation class SubscriptionUnscheduleCancellationParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/subscription_unschedule_cancellation_response.rb b/lib/orb/models/subscription_unschedule_cancellation_response.rb index f6eb957b..4e2db2d3 100644 --- a/lib/orb/models/subscription_unschedule_cancellation_response.rb +++ b/lib/orb/models/subscription_unschedule_cancellation_response.rb @@ -211,69 +211,75 @@ class SubscriptionUnscheduleCancellationResponse < Orb::Internal::Type::BaseMode -> { Orb::Models::SubscriptionUnscheduleCancellationResponse::ChangedResources }, nil?: true - # @!parse - # # @param id [String] - # # @param active_plan_phase_order [Integer, nil] - # # @param adjustment_intervals [Array] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUnscheduleCancellationResponse::BillingCycleAnchorConfiguration] - # # @param billing_cycle_day [Integer] - # # @param created_at [Time] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param customer [Orb::Models::Customer] - # # @param default_invoice_memo [String, nil] - # # @param discount_intervals [Array] - # # @param end_date [Time, nil] - # # @param fixed_fee_quantity_schedule [Array] - # # @param invoicing_threshold [String, nil] - # # @param maximum_intervals [Array] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum_intervals [Array] - # # @param net_terms [Integer] - # # @param pending_subscription_change [Orb::Models::SubscriptionUnscheduleCancellationResponse::PendingSubscriptionChange, nil] - # # @param plan [Orb::Models::Plan] - # # @param price_intervals [Array] - # # @param redeemed_coupon [Orb::Models::SubscriptionUnscheduleCancellationResponse::RedeemedCoupon, nil] - # # @param start_date [Time] - # # @param status [Symbol, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status] - # # @param trial_info [Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo] - # # @param changed_resources [Orb::Models::SubscriptionUnscheduleCancellationResponse::ChangedResources, nil] - # # - # def initialize( - # id:, - # active_plan_phase_order:, - # adjustment_intervals:, - # auto_collection:, - # billing_cycle_anchor_configuration:, - # billing_cycle_day:, - # created_at:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # customer:, - # default_invoice_memo:, - # discount_intervals:, - # end_date:, - # fixed_fee_quantity_schedule:, - # invoicing_threshold:, - # maximum_intervals:, - # metadata:, - # minimum_intervals:, - # net_terms:, - # pending_subscription_change:, - # plan:, - # price_intervals:, - # redeemed_coupon:, - # start_date:, - # status:, - # trial_info:, - # changed_resources: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleCancellationResponse} for more details. + # + # @param id [String] + # + # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase + # ... + # + # @param adjustment_intervals [Array] The adjustment intervals for this subscription sorted by the start_date of the a + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUnscheduleCancellationResponse::BillingCycleAnchorConfiguration] + # + # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param created_at [Time] + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i + # ... + # + # @param discount_intervals [Array] The discount intervals for this subscription sorted by the start_date. + # + # @param end_date [Time, nil] The date Orb stops billing for this subscription. + # + # @param fixed_fee_quantity_schedule [Array] + # + # @param invoicing_threshold [String, nil] + # + # @param maximum_intervals [Array] The maximum intervals for this subscription sorted by the start_date. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum_intervals [Array] The minimum intervals for this subscription sorted by the start_date. + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param pending_subscription_change [Orb::Models::SubscriptionUnscheduleCancellationResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription. + # + # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # ... + # + # @param price_intervals [Array] The price intervals for this subscription. + # + # @param redeemed_coupon [Orb::Models::SubscriptionUnscheduleCancellationResponse::RedeemedCoupon, nil] + # + # @param start_date [Time] The date Orb starts billing for this subscription. + # + # @param status [Symbol, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status] + # + # @param trial_info [Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo] + # + # @param changed_resources [Orb::Models::SubscriptionUnscheduleCancellationResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet + # ... class AdjustmentInterval < Orb::Internal::Type::BaseModel # @!attribute id @@ -305,16 +311,16 @@ class AdjustmentInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param id [String] - # # @param adjustment [Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) + # @param id [String] + # + # @param adjustment [Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # + # @param applies_to_price_interval_ids [Array] The price interval IDs that this adjustment applies to. + # + # @param end_date [Time, nil] The end date of the adjustment interval. + # + # @param start_date [Time] The start date of the adjustment interval. # @see Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval#adjustment module Adjustment @@ -380,29 +386,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -448,29 +451,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -516,29 +516,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -590,31 +587,28 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -660,34 +654,30 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] end end @@ -717,14 +707,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleCancellationResponse::BillingCycleAnchorConfiguration} + # for more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end module DiscountInterval @@ -777,27 +772,18 @@ class AmountDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param discount_type [Symbol, :amount] - # # - # def initialize( - # amount_discount:, - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # discount_type: :amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount) + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -837,27 +823,23 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param percentage_discount [Float] - # # @param start_date [Time] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # percentage_discount:, - # start_date:, - # discount_type: :percentage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1 + # ... + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -897,32 +879,27 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # usage_discount:, - # discount_type: :usage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval)] end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -946,15 +923,11 @@ class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param end_date [Time, nil] - # # @param price_id [String] - # # @param quantity [Float] - # # @param start_date [Time] - # # - # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, price_id:, quantity:, start_date:) + # @param end_date [Time, nil] + # @param price_id [String] + # @param quantity [Float] + # @param start_date [Time] end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -989,16 +962,21 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param maximum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleCancellationResponse::MaximumInterval} for + # more details. + # + # @param applies_to_price_ids [Array] The price ids that this maximum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this maximum interval applies to. + # + # @param end_date [Time, nil] The end date of the maximum interval. + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the maximum interval. end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1033,16 +1011,21 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param minimum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleCancellationResponse::MinimumInterval} for + # more details. + # + # @param applies_to_price_ids [Array] The price ids that this minimum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this minimum interval applies to. + # + # @param end_date [Time, nil] The end date of the minimum interval. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the minimum interval. end # @see Orb::Models::SubscriptionUnscheduleCancellationResponse#pending_subscription_change @@ -1052,14 +1035,10 @@ class PendingSubscriptionChange < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # A pending subscription change if one exists on this subscription. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # A pending subscription change if one exists on this subscription. + # + # @param id [String] end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1141,39 +1120,41 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. - # # - # # @param id [String] - # # @param billing_cycle_day [Integer] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param end_date [Time, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param start_date [Time] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # billing_cycle_day:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # end_date:, - # filter:, - # fixed_fee_quantity_transitions:, - # price:, - # start_date:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleCancellationResponse::PriceInterval} for + # more details. + # + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + # + # @param id [String] + # + # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. + # + # @param fixed_fee_quantity_transitions [Array, nil] The fixed fee quantity transitions for this price interval. This is only relevan + # ... + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @!attribute effective_date @@ -1191,14 +1172,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param price_id [String] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, price_id:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, price_id:, quantity:) + # @param effective_date [Time] + # @param price_id [String] + # @param quantity [Integer] end end @@ -1219,14 +1196,10 @@ class RedeemedCoupon < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param coupon_id [String] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(coupon_id:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(coupon_id:, end_date:, start_date:) + # @param coupon_id [String] + # @param end_date [Time, nil] + # @param start_date [Time] end # @see Orb::Models::SubscriptionUnscheduleCancellationResponse#status @@ -1237,11 +1210,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionUnscheduleCancellationResponse#trial_info @@ -1251,12 +1221,8 @@ class TrialInfo < Orb::Internal::Type::BaseModel # @return [Time, nil] required :end_date, Time, nil?: true - # @!parse - # # @param end_date [Time, nil] - # # - # def initialize(end_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:) + # @param end_date [Time, nil] end # @see Orb::Models::SubscriptionUnscheduleCancellationResponse#changed_resources @@ -1285,19 +1251,18 @@ class ChangedResources < Orb::Internal::Type::BaseModel # @return [Array] required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } - # @!parse - # # The resources that were changed as part of this operation. Only present when - # # fetched through the subscription changes API or if the - # # `include_changed_resources` parameter was passed in the request. - # # - # # @param created_credit_notes [Array] - # # @param created_invoices [Array] - # # @param voided_credit_notes [Array] - # # @param voided_invoices [Array] - # # - # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:) + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @param created_credit_notes [Array] The credit notes that were created as part of this operation. + # + # @param created_invoices [Array] The invoices that were created as part of this operation. + # + # @param voided_credit_notes [Array] The credit notes that were voided as part of this operation. + # + # @param voided_invoices [Array] The invoices that were voided as part of this operation. end end end diff --git a/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb b/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb index c28e29fa..db41b18d 100644 --- a/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +++ b/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Subscriptions#unschedule_fixed_fee_quantity_updates class SubscriptionUnscheduleFixedFeeQuantityUpdatesParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute price_id @@ -14,13 +13,10 @@ class SubscriptionUnscheduleFixedFeeQuantityUpdatesParams < Orb::Internal::Type: # @return [String] required :price_id, String - # @!parse - # # @param price_id [String] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(price_id:, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(price_id:, request_options: {}) + # @param price_id [String] Price for which the updates should be cleared. Must be a fixed fee. + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb b/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb index 8b549303..8f167423 100644 --- a/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +++ b/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb @@ -211,69 +211,76 @@ class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::Internal::Typ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources }, nil?: true - # @!parse - # # @param id [String] - # # @param active_plan_phase_order [Integer, nil] - # # @param adjustment_intervals [Array] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::BillingCycleAnchorConfiguration] - # # @param billing_cycle_day [Integer] - # # @param created_at [Time] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param customer [Orb::Models::Customer] - # # @param default_invoice_memo [String, nil] - # # @param discount_intervals [Array] - # # @param end_date [Time, nil] - # # @param fixed_fee_quantity_schedule [Array] - # # @param invoicing_threshold [String, nil] - # # @param maximum_intervals [Array] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum_intervals [Array] - # # @param net_terms [Integer] - # # @param pending_subscription_change [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange, nil] - # # @param plan [Orb::Models::Plan] - # # @param price_intervals [Array] - # # @param redeemed_coupon [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::RedeemedCoupon, nil] - # # @param start_date [Time] - # # @param status [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status] - # # @param trial_info [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo] - # # @param changed_resources [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources, nil] - # # - # def initialize( - # id:, - # active_plan_phase_order:, - # adjustment_intervals:, - # auto_collection:, - # billing_cycle_anchor_configuration:, - # billing_cycle_day:, - # created_at:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # customer:, - # default_invoice_memo:, - # discount_intervals:, - # end_date:, - # fixed_fee_quantity_schedule:, - # invoicing_threshold:, - # maximum_intervals:, - # metadata:, - # minimum_intervals:, - # net_terms:, - # pending_subscription_change:, - # plan:, - # price_intervals:, - # redeemed_coupon:, - # start_date:, - # status:, - # trial_info:, - # changed_resources: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse} for more + # details. + # + # @param id [String] + # + # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase + # ... + # + # @param adjustment_intervals [Array] The adjustment intervals for this subscription sorted by the start_date of the a + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::BillingCycleAnchorConfiguration] + # + # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param created_at [Time] + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i + # ... + # + # @param discount_intervals [Array] The discount intervals for this subscription sorted by the start_date. + # + # @param end_date [Time, nil] The date Orb stops billing for this subscription. + # + # @param fixed_fee_quantity_schedule [Array] + # + # @param invoicing_threshold [String, nil] + # + # @param maximum_intervals [Array] The maximum intervals for this subscription sorted by the start_date. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum_intervals [Array] The minimum intervals for this subscription sorted by the start_date. + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param pending_subscription_change [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription. + # + # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # ... + # + # @param price_intervals [Array] The price intervals for this subscription. + # + # @param redeemed_coupon [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::RedeemedCoupon, nil] + # + # @param start_date [Time] The date Orb starts billing for this subscription. + # + # @param status [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status] + # + # @param trial_info [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo] + # + # @param changed_resources [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet + # ... class AdjustmentInterval < Orb::Internal::Type::BaseModel # @!attribute id @@ -305,16 +312,16 @@ class AdjustmentInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param id [String] - # # @param adjustment [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) + # @param id [String] + # + # @param adjustment [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # + # @param applies_to_price_interval_ids [Array] The price interval IDs that this adjustment applies to. + # + # @param end_date [Time, nil] The end date of the adjustment interval. + # + # @param start_date [Time] The start date of the adjustment interval. # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval#adjustment module Adjustment @@ -380,29 +387,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -448,29 +452,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -516,29 +517,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -590,31 +588,28 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -660,34 +655,30 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] end end @@ -717,14 +708,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::BillingCycleAnchorConfiguration} + # for more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end module DiscountInterval @@ -777,27 +773,18 @@ class AmountDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param discount_type [Symbol, :amount] - # # - # def initialize( - # amount_discount:, - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # discount_type: :amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount) + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -837,27 +824,23 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param percentage_discount [Float] - # # @param start_date [Time] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # percentage_discount:, - # start_date:, - # discount_type: :percentage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1 + # ... + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -897,32 +880,27 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # usage_discount:, - # discount_type: :usage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval)] end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -946,15 +924,11 @@ class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param end_date [Time, nil] - # # @param price_id [String] - # # @param quantity [Float] - # # @param start_date [Time] - # # - # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, price_id:, quantity:, start_date:) + # @param end_date [Time, nil] + # @param price_id [String] + # @param quantity [Float] + # @param start_date [Time] end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -989,16 +963,21 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param maximum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this maximum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this maximum interval applies to. + # + # @param end_date [Time, nil] The end date of the maximum interval. + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the maximum interval. end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1033,16 +1012,21 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param minimum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this minimum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this minimum interval applies to. + # + # @param end_date [Time, nil] The end date of the minimum interval. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the minimum interval. end # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#pending_subscription_change @@ -1052,14 +1036,10 @@ class PendingSubscriptionChange < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # A pending subscription change if one exists on this subscription. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # A pending subscription change if one exists on this subscription. + # + # @param id [String] end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1145,39 +1125,41 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. - # # - # # @param id [String] - # # @param billing_cycle_day [Integer] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param end_date [Time, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param start_date [Time] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # billing_cycle_day:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # end_date:, - # filter:, - # fixed_fee_quantity_transitions:, - # price:, - # start_date:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval} + # for more details. + # + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + # + # @param id [String] + # + # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. + # + # @param fixed_fee_quantity_transitions [Array, nil] The fixed fee quantity transitions for this price interval. This is only relevan + # ... + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @!attribute effective_date @@ -1195,14 +1177,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param price_id [String] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, price_id:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, price_id:, quantity:) + # @param effective_date [Time] + # @param price_id [String] + # @param quantity [Integer] end end @@ -1223,14 +1201,10 @@ class RedeemedCoupon < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param coupon_id [String] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(coupon_id:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(coupon_id:, end_date:, start_date:) + # @param coupon_id [String] + # @param end_date [Time, nil] + # @param start_date [Time] end # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#status @@ -1241,11 +1215,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#trial_info @@ -1255,12 +1226,8 @@ class TrialInfo < Orb::Internal::Type::BaseModel # @return [Time, nil] required :end_date, Time, nil?: true - # @!parse - # # @param end_date [Time, nil] - # # - # def initialize(end_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:) + # @param end_date [Time, nil] end # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#changed_resources @@ -1289,19 +1256,18 @@ class ChangedResources < Orb::Internal::Type::BaseModel # @return [Array] required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } - # @!parse - # # The resources that were changed as part of this operation. Only present when - # # fetched through the subscription changes API or if the - # # `include_changed_resources` parameter was passed in the request. - # # - # # @param created_credit_notes [Array] - # # @param created_invoices [Array] - # # @param voided_credit_notes [Array] - # # @param voided_invoices [Array] - # # - # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:) + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @param created_credit_notes [Array] The credit notes that were created as part of this operation. + # + # @param created_invoices [Array] The invoices that were created as part of this operation. + # + # @param voided_credit_notes [Array] The credit notes that were voided as part of this operation. + # + # @param voided_invoices [Array] The invoices that were voided as part of this operation. end end end diff --git a/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb b/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb index 3a47d9ed..e4688907 100644 --- a/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +++ b/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::Subscriptions#unschedule_pending_plan_changes class SubscriptionUnschedulePendingPlanChangesParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb b/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb index 3caa8ec2..9e392245 100644 --- a/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +++ b/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb @@ -211,69 +211,76 @@ class SubscriptionUnschedulePendingPlanChangesResponse < Orb::Internal::Type::Ba -> { Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources }, nil?: true - # @!parse - # # @param id [String] - # # @param active_plan_phase_order [Integer, nil] - # # @param adjustment_intervals [Array] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::BillingCycleAnchorConfiguration] - # # @param billing_cycle_day [Integer] - # # @param created_at [Time] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param customer [Orb::Models::Customer] - # # @param default_invoice_memo [String, nil] - # # @param discount_intervals [Array] - # # @param end_date [Time, nil] - # # @param fixed_fee_quantity_schedule [Array] - # # @param invoicing_threshold [String, nil] - # # @param maximum_intervals [Array] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum_intervals [Array] - # # @param net_terms [Integer] - # # @param pending_subscription_change [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange, nil] - # # @param plan [Orb::Models::Plan] - # # @param price_intervals [Array] - # # @param redeemed_coupon [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::RedeemedCoupon, nil] - # # @param start_date [Time] - # # @param status [Symbol, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status] - # # @param trial_info [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo] - # # @param changed_resources [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources, nil] - # # - # def initialize( - # id:, - # active_plan_phase_order:, - # adjustment_intervals:, - # auto_collection:, - # billing_cycle_anchor_configuration:, - # billing_cycle_day:, - # created_at:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # customer:, - # default_invoice_memo:, - # discount_intervals:, - # end_date:, - # fixed_fee_quantity_schedule:, - # invoicing_threshold:, - # maximum_intervals:, - # metadata:, - # minimum_intervals:, - # net_terms:, - # pending_subscription_change:, - # plan:, - # price_intervals:, - # redeemed_coupon:, - # start_date:, - # status:, - # trial_info:, - # changed_resources: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse} for more + # details. + # + # @param id [String] + # + # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase + # ... + # + # @param adjustment_intervals [Array] The adjustment intervals for this subscription sorted by the start_date of the a + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::BillingCycleAnchorConfiguration] + # + # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param created_at [Time] + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i + # ... + # + # @param discount_intervals [Array] The discount intervals for this subscription sorted by the start_date. + # + # @param end_date [Time, nil] The date Orb stops billing for this subscription. + # + # @param fixed_fee_quantity_schedule [Array] + # + # @param invoicing_threshold [String, nil] + # + # @param maximum_intervals [Array] The maximum intervals for this subscription sorted by the start_date. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum_intervals [Array] The minimum intervals for this subscription sorted by the start_date. + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param pending_subscription_change [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription. + # + # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # ... + # + # @param price_intervals [Array] The price intervals for this subscription. + # + # @param redeemed_coupon [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::RedeemedCoupon, nil] + # + # @param start_date [Time] The date Orb starts billing for this subscription. + # + # @param status [Symbol, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status] + # + # @param trial_info [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo] + # + # @param changed_resources [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet + # ... class AdjustmentInterval < Orb::Internal::Type::BaseModel # @!attribute id @@ -305,16 +312,16 @@ class AdjustmentInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param id [String] - # # @param adjustment [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) + # @param id [String] + # + # @param adjustment [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # + # @param applies_to_price_interval_ids [Array] The price interval IDs that this adjustment applies to. + # + # @param end_date [Time, nil] The end date of the adjustment interval. + # + # @param start_date [Time] The start date of the adjustment interval. # @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval#adjustment module Adjustment @@ -380,29 +387,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -448,29 +452,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -516,29 +517,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -590,31 +588,28 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -660,34 +655,30 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] end end @@ -717,14 +708,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::BillingCycleAnchorConfiguration} + # for more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end module DiscountInterval @@ -777,27 +773,18 @@ class AmountDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param discount_type [Symbol, :amount] - # # - # def initialize( - # amount_discount:, - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # discount_type: :amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount) + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -837,27 +824,23 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param percentage_discount [Float] - # # @param start_date [Time] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # percentage_discount:, - # start_date:, - # discount_type: :percentage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1 + # ... + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -897,32 +880,27 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # usage_discount:, - # discount_type: :usage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval)] end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -946,15 +924,11 @@ class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param end_date [Time, nil] - # # @param price_id [String] - # # @param quantity [Float] - # # @param start_date [Time] - # # - # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, price_id:, quantity:, start_date:) + # @param end_date [Time, nil] + # @param price_id [String] + # @param quantity [Float] + # @param start_date [Time] end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -989,16 +963,21 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param maximum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MaximumInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this maximum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this maximum interval applies to. + # + # @param end_date [Time, nil] The end date of the maximum interval. + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the maximum interval. end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1033,16 +1012,21 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param minimum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MinimumInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this minimum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this minimum interval applies to. + # + # @param end_date [Time, nil] The end date of the minimum interval. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the minimum interval. end # @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse#pending_subscription_change @@ -1052,14 +1036,10 @@ class PendingSubscriptionChange < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # A pending subscription change if one exists on this subscription. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # A pending subscription change if one exists on this subscription. + # + # @param id [String] end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1141,39 +1121,41 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. - # # - # # @param id [String] - # # @param billing_cycle_day [Integer] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param end_date [Time, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param start_date [Time] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # billing_cycle_day:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # end_date:, - # filter:, - # fixed_fee_quantity_transitions:, - # price:, - # start_date:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval} + # for more details. + # + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + # + # @param id [String] + # + # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. + # + # @param fixed_fee_quantity_transitions [Array, nil] The fixed fee quantity transitions for this price interval. This is only relevan + # ... + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @!attribute effective_date @@ -1191,14 +1173,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param price_id [String] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, price_id:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, price_id:, quantity:) + # @param effective_date [Time] + # @param price_id [String] + # @param quantity [Integer] end end @@ -1219,14 +1197,10 @@ class RedeemedCoupon < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param coupon_id [String] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(coupon_id:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(coupon_id:, end_date:, start_date:) + # @param coupon_id [String] + # @param end_date [Time, nil] + # @param start_date [Time] end # @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse#status @@ -1237,11 +1211,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse#trial_info @@ -1251,12 +1222,8 @@ class TrialInfo < Orb::Internal::Type::BaseModel # @return [Time, nil] required :end_date, Time, nil?: true - # @!parse - # # @param end_date [Time, nil] - # # - # def initialize(end_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:) + # @param end_date [Time, nil] end # @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse#changed_resources @@ -1285,19 +1252,18 @@ class ChangedResources < Orb::Internal::Type::BaseModel # @return [Array] required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } - # @!parse - # # The resources that were changed as part of this operation. Only present when - # # fetched through the subscription changes API or if the - # # `include_changed_resources` parameter was passed in the request. - # # - # # @param created_credit_notes [Array] - # # @param created_invoices [Array] - # # @param voided_credit_notes [Array] - # # @param voided_invoices [Array] - # # - # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:) + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @param created_credit_notes [Array] The credit notes that were created as part of this operation. + # + # @param created_invoices [Array] The invoices that were created as part of this operation. + # + # @param voided_credit_notes [Array] The credit notes that were voided as part of this operation. + # + # @param voided_invoices [Array] The invoices that were voided as part of this operation. end end end diff --git a/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb b/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb index 99c55a37..88dbe554 100644 --- a/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +++ b/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Subscriptions#update_fixed_fee_quantity class SubscriptionUpdateFixedFeeQuantityParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute price_id @@ -27,7 +26,7 @@ class SubscriptionUpdateFixedFeeQuantityParams < Orb::Internal::Type::BaseModel # @return [Boolean, nil] optional :allow_invoice_credit_or_void, Orb::Internal::Type::Boolean, nil?: true - # @!attribute [r] change_option + # @!attribute change_option # Determines when the change takes effect. Note that if `effective_date` is # specified, this defaults to `effective_date`. Otherwise, this defaults to # `immediate` unless it's explicitly set to `upcoming_invoice`. @@ -35,10 +34,6 @@ class SubscriptionUpdateFixedFeeQuantityParams < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption, nil] optional :change_option, enum: -> { Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption } - # @!parse - # # @return [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption] - # attr_writer :change_option - # @!attribute effective_date # The date that the quantity change should take effect, localized to the # customer's timezone. Ifthis parameter is not passed in, the quantity change is @@ -47,27 +42,24 @@ class SubscriptionUpdateFixedFeeQuantityParams < Orb::Internal::Type::BaseModel # @return [Date, nil] optional :effective_date, Date, nil?: true - # @!parse - # # @param price_id [String] - # # @param quantity [Float] - # # @param allow_invoice_credit_or_void [Boolean, nil] - # # @param change_option [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption] - # # @param effective_date [Date, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # price_id:, - # quantity:, - # allow_invoice_credit_or_void: nil, - # change_option: nil, - # effective_date: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(price_id:, quantity:, allow_invoice_credit_or_void: nil, change_option: nil, effective_date: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateFixedFeeQuantityParams} for more details. + # + # @param price_id [String] Price for which the quantity should be updated. Must be a fixed fee. + # + # @param quantity [Float] + # + # @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a + # ... + # + # @param change_option [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption] Determines when the change takes effect. Note that if `effective_date` is specif + # ... + # + # @param effective_date [Date, nil] The date that the quantity change should take effect, localized to the customer' + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] # Determines when the change takes effect. Note that if `effective_date` is # specified, this defaults to `effective_date`. Otherwise, this defaults to @@ -79,11 +71,8 @@ module ChangeOption UPCOMING_INVOICE = :upcoming_invoice EFFECTIVE_DATE = :effective_date - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb b/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb index fab692bf..cac3d6c7 100644 --- a/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +++ b/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb @@ -211,69 +211,75 @@ class SubscriptionUpdateFixedFeeQuantityResponse < Orb::Internal::Type::BaseMode -> { Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources }, nil?: true - # @!parse - # # @param id [String] - # # @param active_plan_phase_order [Integer, nil] - # # @param adjustment_intervals [Array] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::BillingCycleAnchorConfiguration] - # # @param billing_cycle_day [Integer] - # # @param created_at [Time] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param customer [Orb::Models::Customer] - # # @param default_invoice_memo [String, nil] - # # @param discount_intervals [Array] - # # @param end_date [Time, nil] - # # @param fixed_fee_quantity_schedule [Array] - # # @param invoicing_threshold [String, nil] - # # @param maximum_intervals [Array] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum_intervals [Array] - # # @param net_terms [Integer] - # # @param pending_subscription_change [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange, nil] - # # @param plan [Orb::Models::Plan] - # # @param price_intervals [Array] - # # @param redeemed_coupon [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::RedeemedCoupon, nil] - # # @param start_date [Time] - # # @param status [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status] - # # @param trial_info [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo] - # # @param changed_resources [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources, nil] - # # - # def initialize( - # id:, - # active_plan_phase_order:, - # adjustment_intervals:, - # auto_collection:, - # billing_cycle_anchor_configuration:, - # billing_cycle_day:, - # created_at:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # customer:, - # default_invoice_memo:, - # discount_intervals:, - # end_date:, - # fixed_fee_quantity_schedule:, - # invoicing_threshold:, - # maximum_intervals:, - # metadata:, - # minimum_intervals:, - # net_terms:, - # pending_subscription_change:, - # plan:, - # price_intervals:, - # redeemed_coupon:, - # start_date:, - # status:, - # trial_info:, - # changed_resources: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse} for more details. + # + # @param id [String] + # + # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase + # ... + # + # @param adjustment_intervals [Array] The adjustment intervals for this subscription sorted by the start_date of the a + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::BillingCycleAnchorConfiguration] + # + # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param created_at [Time] + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i + # ... + # + # @param discount_intervals [Array] The discount intervals for this subscription sorted by the start_date. + # + # @param end_date [Time, nil] The date Orb stops billing for this subscription. + # + # @param fixed_fee_quantity_schedule [Array] + # + # @param invoicing_threshold [String, nil] + # + # @param maximum_intervals [Array] The maximum intervals for this subscription sorted by the start_date. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum_intervals [Array] The minimum intervals for this subscription sorted by the start_date. + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param pending_subscription_change [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription. + # + # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # ... + # + # @param price_intervals [Array] The price intervals for this subscription. + # + # @param redeemed_coupon [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::RedeemedCoupon, nil] + # + # @param start_date [Time] The date Orb starts billing for this subscription. + # + # @param status [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status] + # + # @param trial_info [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo] + # + # @param changed_resources [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet + # ... class AdjustmentInterval < Orb::Internal::Type::BaseModel # @!attribute id @@ -305,16 +311,16 @@ class AdjustmentInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param id [String] - # # @param adjustment [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) + # @param id [String] + # + # @param adjustment [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # + # @param applies_to_price_interval_ids [Array] The price interval IDs that this adjustment applies to. + # + # @param end_date [Time, nil] The end date of the adjustment interval. + # + # @param start_date [Time] The start date of the adjustment interval. # @see Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval#adjustment module Adjustment @@ -380,29 +386,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -448,29 +451,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -516,29 +516,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -590,31 +587,28 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -660,34 +654,30 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] end end @@ -717,14 +707,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::BillingCycleAnchorConfiguration} + # for more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end module DiscountInterval @@ -777,27 +772,18 @@ class AmountDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param discount_type [Symbol, :amount] - # # - # def initialize( - # amount_discount:, - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # discount_type: :amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount) + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -837,27 +823,23 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param percentage_discount [Float] - # # @param start_date [Time] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # percentage_discount:, - # start_date:, - # discount_type: :percentage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::PercentageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1 + # ... + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -897,32 +879,27 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # usage_discount:, - # discount_type: :usage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::UsageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::UsageDiscountInterval)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::UsageDiscountInterval)] end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -946,15 +923,11 @@ class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param end_date [Time, nil] - # # @param price_id [String] - # # @param quantity [Float] - # # @param start_date [Time] - # # - # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, price_id:, quantity:, start_date:) + # @param end_date [Time, nil] + # @param price_id [String] + # @param quantity [Float] + # @param start_date [Time] end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -989,16 +962,21 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param maximum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MaximumInterval} for + # more details. + # + # @param applies_to_price_ids [Array] The price ids that this maximum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this maximum interval applies to. + # + # @param end_date [Time, nil] The end date of the maximum interval. + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the maximum interval. end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1033,16 +1011,21 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param minimum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MinimumInterval} for + # more details. + # + # @param applies_to_price_ids [Array] The price ids that this minimum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this minimum interval applies to. + # + # @param end_date [Time, nil] The end date of the minimum interval. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the minimum interval. end # @see Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse#pending_subscription_change @@ -1052,14 +1035,10 @@ class PendingSubscriptionChange < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # A pending subscription change if one exists on this subscription. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # A pending subscription change if one exists on this subscription. + # + # @param id [String] end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1141,39 +1120,41 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. - # # - # # @param id [String] - # # @param billing_cycle_day [Integer] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param end_date [Time, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param start_date [Time] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # billing_cycle_day:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # end_date:, - # filter:, - # fixed_fee_quantity_transitions:, - # price:, - # start_date:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval} for + # more details. + # + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + # + # @param id [String] + # + # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. + # + # @param fixed_fee_quantity_transitions [Array, nil] The fixed fee quantity transitions for this price interval. This is only relevan + # ... + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @!attribute effective_date @@ -1191,14 +1172,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param price_id [String] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, price_id:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, price_id:, quantity:) + # @param effective_date [Time] + # @param price_id [String] + # @param quantity [Integer] end end @@ -1219,14 +1196,10 @@ class RedeemedCoupon < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param coupon_id [String] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(coupon_id:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(coupon_id:, end_date:, start_date:) + # @param coupon_id [String] + # @param end_date [Time, nil] + # @param start_date [Time] end # @see Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse#status @@ -1237,11 +1210,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse#trial_info @@ -1251,12 +1221,8 @@ class TrialInfo < Orb::Internal::Type::BaseModel # @return [Time, nil] required :end_date, Time, nil?: true - # @!parse - # # @param end_date [Time, nil] - # # - # def initialize(end_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:) + # @param end_date [Time, nil] end # @see Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse#changed_resources @@ -1285,19 +1251,18 @@ class ChangedResources < Orb::Internal::Type::BaseModel # @return [Array] required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } - # @!parse - # # The resources that were changed as part of this operation. Only present when - # # fetched through the subscription changes API or if the - # # `include_changed_resources` parameter was passed in the request. - # # - # # @param created_credit_notes [Array] - # # @param created_invoices [Array] - # # @param voided_credit_notes [Array] - # # @param voided_invoices [Array] - # # - # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:) + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @param created_credit_notes [Array] The credit notes that were created as part of this operation. + # + # @param created_invoices [Array] The invoices that were created as part of this operation. + # + # @param voided_credit_notes [Array] The credit notes that were voided as part of this operation. + # + # @param voided_invoices [Array] The invoices that were voided as part of this operation. end end end diff --git a/lib/orb/models/subscription_update_params.rb b/lib/orb/models/subscription_update_params.rb index 5186bb9f..47a6f2e4 100644 --- a/lib/orb/models/subscription_update_params.rb +++ b/lib/orb/models/subscription_update_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Subscriptions#update class SubscriptionUpdateParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute auto_collection @@ -48,27 +47,26 @@ class SubscriptionUpdateParams < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :net_terms, Integer, nil?: true - # @!parse - # # @param auto_collection [Boolean, nil] - # # @param default_invoice_memo [String, nil] - # # @param invoicing_threshold [String, nil] - # # @param metadata [Hash{Symbol=>String, nil}, nil] - # # @param net_terms [Integer, nil] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # auto_collection: nil, - # default_invoice_memo: nil, - # invoicing_threshold: nil, - # metadata: nil, - # net_terms: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(auto_collection: nil, default_invoice_memo: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateParams} for more details. + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscription's invoices. Note that if this i + # ... + # + # @param invoicing_threshold [String, nil] When this subscription's accrued usage reaches this threshold, an invoice will b + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param net_terms [Integer, nil] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/subscription_update_trial_params.rb b/lib/orb/models/subscription_update_trial_params.rb index 665c1e95..047524c9 100644 --- a/lib/orb/models/subscription_update_trial_params.rb +++ b/lib/orb/models/subscription_update_trial_params.rb @@ -4,8 +4,7 @@ module Orb module Models # @see Orb::Resources::Subscriptions#update_trial class SubscriptionUpdateTrialParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters # @!attribute trial_end_date @@ -15,25 +14,24 @@ class SubscriptionUpdateTrialParams < Orb::Internal::Type::BaseModel # @return [Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate] required :trial_end_date, union: -> { Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate } - # @!attribute [r] shift + # @!attribute shift # If true, shifts subsequent price and adjustment intervals (preserving their # durations, but adjusting their absolute dates). # # @return [Boolean, nil] optional :shift, Orb::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :shift - - # @!parse - # # @param trial_end_date [Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate] - # # @param shift [Boolean] - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(trial_end_date:, shift: nil, request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(trial_end_date:, shift: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateTrialParams} for more details. + # + # @param trial_end_date [Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate] The new date that the trial should end, or the literal string `immediate` to end + # ... + # + # @param shift [Boolean] If true, shifts subsequent price and adjustment intervals (preserving their dura + # ... + # + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] # The new date that the trial should end, or the literal string `immediate` to end # the trial immediately. @@ -44,9 +42,8 @@ module TrialEndDate variant const: -> { Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate::IMMEDIATE } - # @!parse - # # @return [Array(Time, Symbol)] - # def self.variants; end + # @!method self.variants + # @return [Array(Time, Symbol)] # @!group diff --git a/lib/orb/models/subscription_update_trial_response.rb b/lib/orb/models/subscription_update_trial_response.rb index 97dfe022..36b89f6b 100644 --- a/lib/orb/models/subscription_update_trial_response.rb +++ b/lib/orb/models/subscription_update_trial_response.rb @@ -209,69 +209,75 @@ class SubscriptionUpdateTrialResponse < Orb::Internal::Type::BaseModel -> { Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources }, nil?: true - # @!parse - # # @param id [String] - # # @param active_plan_phase_order [Integer, nil] - # # @param adjustment_intervals [Array] - # # @param auto_collection [Boolean, nil] - # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUpdateTrialResponse::BillingCycleAnchorConfiguration] - # # @param billing_cycle_day [Integer] - # # @param created_at [Time] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param customer [Orb::Models::Customer] - # # @param default_invoice_memo [String, nil] - # # @param discount_intervals [Array] - # # @param end_date [Time, nil] - # # @param fixed_fee_quantity_schedule [Array] - # # @param invoicing_threshold [String, nil] - # # @param maximum_intervals [Array] - # # @param metadata [Hash{Symbol=>String}] - # # @param minimum_intervals [Array] - # # @param net_terms [Integer] - # # @param pending_subscription_change [Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange, nil] - # # @param plan [Orb::Models::Plan] - # # @param price_intervals [Array] - # # @param redeemed_coupon [Orb::Models::SubscriptionUpdateTrialResponse::RedeemedCoupon, nil] - # # @param start_date [Time] - # # @param status [Symbol, Orb::Models::SubscriptionUpdateTrialResponse::Status] - # # @param trial_info [Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo] - # # @param changed_resources [Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources, nil] - # # - # def initialize( - # id:, - # active_plan_phase_order:, - # adjustment_intervals:, - # auto_collection:, - # billing_cycle_anchor_configuration:, - # billing_cycle_day:, - # created_at:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # customer:, - # default_invoice_memo:, - # discount_intervals:, - # end_date:, - # fixed_fee_quantity_schedule:, - # invoicing_threshold:, - # maximum_intervals:, - # metadata:, - # minimum_intervals:, - # net_terms:, - # pending_subscription_change:, - # plan:, - # price_intervals:, - # redeemed_coupon:, - # start_date:, - # status:, - # trial_info:, - # changed_resources: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateTrialResponse} for more details. + # + # @param id [String] + # + # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase + # ... + # + # @param adjustment_intervals [Array] The adjustment intervals for this subscription sorted by the start_date of the a + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUpdateTrialResponse::BillingCycleAnchorConfiguration] + # + # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param created_at [Time] + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i + # ... + # + # @param discount_intervals [Array] The discount intervals for this subscription sorted by the start_date. + # + # @param end_date [Time, nil] The date Orb stops billing for this subscription. + # + # @param fixed_fee_quantity_schedule [Array] + # + # @param invoicing_threshold [String, nil] + # + # @param maximum_intervals [Array] The maximum intervals for this subscription sorted by the start_date. + # + # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t + # ... + # + # @param minimum_intervals [Array] The minimum intervals for this subscription sorted by the start_date. + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param pending_subscription_change [Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription. + # + # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # ... + # + # @param price_intervals [Array] The price intervals for this subscription. + # + # @param redeemed_coupon [Orb::Models::SubscriptionUpdateTrialResponse::RedeemedCoupon, nil] + # + # @param start_date [Time] The date Orb starts billing for this subscription. + # + # @param status [Symbol, Orb::Models::SubscriptionUpdateTrialResponse::Status] + # + # @param trial_info [Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo] + # + # @param changed_resources [Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet + # ... class AdjustmentInterval < Orb::Internal::Type::BaseModel # @!attribute id @@ -303,16 +309,16 @@ class AdjustmentInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param id [String] - # # @param adjustment [Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) + # @param id [String] + # + # @param adjustment [Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # + # @param applies_to_price_interval_ids [Array] The price interval IDs that this adjustment applies to. + # + # @param end_date [Time, nil] The end date of the adjustment interval. + # + # @param start_date [Time] The start date of the adjustment interval. # @see Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval#adjustment module Adjustment @@ -378,29 +384,26 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param usage_discount [Float] - # # @param adjustment_type [Symbol, :usage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # usage_discount:, - # adjustment_type: :usage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies + # ... + # + # @param adjustment_type [Symbol, :usage_discount] end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -446,29 +449,26 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :amount_discount] - # # - # def initialize( - # id:, - # amount_discount:, - # applies_to_price_ids:, - # is_invoice_level:, - # plan_phase_order:, - # reason:, - # adjustment_type: :amount_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given + # ... + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :amount_discount] end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -514,29 +514,26 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param percentage_discount [Float] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :percentage_discount] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # percentage_discount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :percentage_discount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :percentage_discount] end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -588,31 +585,28 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param item_id [String] - # # @param minimum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :minimum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # item_id:, - # minimum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :minimum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param item_id [String] The item ID that revenue from this minimum will be attributed to. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :minimum] end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -658,34 +652,30 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @return [String, nil] required :reason, String, nil?: true - # @!parse - # # @param id [String] - # # @param applies_to_price_ids [Array] - # # @param is_invoice_level [Boolean] - # # @param maximum_amount [String] - # # @param plan_phase_order [Integer, nil] - # # @param reason [String, nil] - # # @param adjustment_type [Symbol, :maximum] - # # - # def initialize( - # id:, - # applies_to_price_ids:, - # is_invoice_level:, - # maximum_amount:, - # plan_phase_order:, - # reason:, - # adjustment_type: :maximum, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment} + # for more details. + # + # @param id [String] + # + # @param applies_to_price_ids [Array] The price IDs that this adjustment applies to. + # + # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha + # ... + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus + # ... + # + # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active. + # + # @param reason [String, nil] The reason for the adjustment. + # + # @param adjustment_type [Symbol, :maximum] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] end end @@ -715,14 +705,19 @@ class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @return [Integer, nil] optional :year, Integer, nil?: true - # @!parse - # # @param day [Integer] - # # @param month [Integer, nil] - # # @param year [Integer, nil] - # # - # def initialize(day:, month: nil, year: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(day:, month: nil, year: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateTrialResponse::BillingCycleAnchorConfiguration} + # for more details. + # + # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb + # ... + # + # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore + # ... + # + # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc + # ... end module DiscountInterval @@ -775,27 +770,18 @@ class AmountDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param amount_discount [String] - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param discount_type [Symbol, :amount] - # # - # def initialize( - # amount_discount:, - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # discount_type: :amount, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount) + # @param amount_discount [String] Only available if discount_type is `amount`. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :amount] end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -835,27 +821,23 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param percentage_discount [Float] - # # @param start_date [Time] - # # @param discount_type [Symbol, :percentage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # percentage_discount:, - # start_date:, - # discount_type: :percentage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1 + # ... + # + # @param start_date [Time] The start date of the discount interval. + # + # @param discount_type [Symbol, :percentage] end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -895,32 +877,27 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @return [Float] required :usage_discount, Float - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # @param usage_discount [Float] - # # @param discount_type [Symbol, :usage] - # # - # def initialize( - # applies_to_price_ids:, - # applies_to_price_interval_ids:, - # end_date:, - # start_date:, - # usage_discount:, - # discount_type: :usage, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval} + # for more details. + # + # @param applies_to_price_ids [Array] The price ids that this discount interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this discount interval applies to. + # + # @param end_date [Time, nil] The end date of the discount interval. + # + # @param start_date [Time] The start date of the discount interval. + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param discount_type [Symbol, :usage] end - # @!parse - # # @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval)] end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -944,15 +921,11 @@ class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param end_date [Time, nil] - # # @param price_id [String] - # # @param quantity [Float] - # # @param start_date [Time] - # # - # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:, price_id:, quantity:, start_date:) + # @param end_date [Time, nil] + # @param price_id [String] + # @param quantity [Float] + # @param start_date [Time] end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -987,16 +960,21 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param maximum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateTrialResponse::MaximumInterval} for more + # details. + # + # @param applies_to_price_ids [Array] The price ids that this maximum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this maximum interval applies to. + # + # @param end_date [Time, nil] The end date of the maximum interval. + # + # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the maximum interval. end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1031,16 +1009,21 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param applies_to_price_ids [Array] - # # @param applies_to_price_interval_ids [Array] - # # @param end_date [Time, nil] - # # @param minimum_amount [String] - # # @param start_date [Time] - # # - # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateTrialResponse::MinimumInterval} for more + # details. + # + # @param applies_to_price_ids [Array] The price ids that this minimum interval applies to. + # + # @param applies_to_price_interval_ids [Array] The price interval ids that this minimum interval applies to. + # + # @param end_date [Time, nil] The end date of the minimum interval. + # + # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t + # ... + # + # @param start_date [Time] The start date of the minimum interval. end # @see Orb::Models::SubscriptionUpdateTrialResponse#pending_subscription_change @@ -1050,14 +1033,10 @@ class PendingSubscriptionChange < Orb::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # A pending subscription change if one exists on this subscription. - # # - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # A pending subscription change if one exists on this subscription. + # + # @param id [String] end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1139,39 +1118,40 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true - # @!parse - # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. - # # - # # @param id [String] - # # @param billing_cycle_day [Integer] - # # @param current_billing_period_end_date [Time, nil] - # # @param current_billing_period_start_date [Time, nil] - # # @param end_date [Time, nil] - # # @param filter [String, nil] - # # @param fixed_fee_quantity_transitions [Array, nil] - # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] - # # @param start_date [Time] - # # @param usage_customer_ids [Array, nil] - # # - # def initialize( - # id:, - # billing_cycle_day:, - # current_billing_period_end_date:, - # current_billing_period_start_date:, - # end_date:, - # filter:, - # fixed_fee_quantity_transitions:, - # price:, - # start_date:, - # usage_customer_ids:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:) + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval} for more details. + # + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + # + # @param id [String] + # + # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price + # + # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that + # ... + # + # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th + # ... + # + # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. + # + # @param fixed_fee_quantity_transitions [Array, nil] The fixed fee quantity transitions for this price interval. This is only relevan + # ... + # + # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu + # ... + # + # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @!attribute effective_date @@ -1189,14 +1169,10 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel # @return [Integer] required :quantity, Integer - # @!parse - # # @param effective_date [Time] - # # @param price_id [String] - # # @param quantity [Integer] - # # - # def initialize(effective_date:, price_id:, quantity:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, price_id:, quantity:) + # @param effective_date [Time] + # @param price_id [String] + # @param quantity [Integer] end end @@ -1217,14 +1193,10 @@ class RedeemedCoupon < Orb::Internal::Type::BaseModel # @return [Time] required :start_date, Time - # @!parse - # # @param coupon_id [String] - # # @param end_date [Time, nil] - # # @param start_date [Time] - # # - # def initialize(coupon_id:, end_date:, start_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(coupon_id:, end_date:, start_date:) + # @param coupon_id [String] + # @param end_date [Time, nil] + # @param start_date [Time] end # @see Orb::Models::SubscriptionUpdateTrialResponse#status @@ -1235,11 +1207,8 @@ module Status ENDED = :ended UPCOMING = :upcoming - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Orb::Models::SubscriptionUpdateTrialResponse#trial_info @@ -1249,12 +1218,8 @@ class TrialInfo < Orb::Internal::Type::BaseModel # @return [Time, nil] required :end_date, Time, nil?: true - # @!parse - # # @param end_date [Time, nil] - # # - # def initialize(end_date:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(end_date:) + # @param end_date [Time, nil] end # @see Orb::Models::SubscriptionUpdateTrialResponse#changed_resources @@ -1283,19 +1248,18 @@ class ChangedResources < Orb::Internal::Type::BaseModel # @return [Array] required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } - # @!parse - # # The resources that were changed as part of this operation. Only present when - # # fetched through the subscription changes API or if the - # # `include_changed_resources` parameter was passed in the request. - # # - # # @param created_credit_notes [Array] - # # @param created_invoices [Array] - # # @param voided_credit_notes [Array] - # # @param voided_invoices [Array] - # # - # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:) + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @param created_credit_notes [Array] The credit notes that were created as part of this operation. + # + # @param created_invoices [Array] The invoices that were created as part of this operation. + # + # @param voided_credit_notes [Array] The credit notes that were voided as part of this operation. + # + # @param voided_invoices [Array] The invoices that were voided as part of this operation. end end end diff --git a/lib/orb/models/subscription_usage.rb b/lib/orb/models/subscription_usage.rb index 965ea4c0..d5691a64 100644 --- a/lib/orb/models/subscription_usage.rb +++ b/lib/orb/models/subscription_usage.rb @@ -17,12 +17,8 @@ class UngroupedSubscriptionUsage < Orb::Internal::Type::BaseModel required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data] } - # @!parse - # # @param data [Array] - # # - # def initialize(data:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(data:) + # @param data [Array] class Data < Orb::Internal::Type::BaseModel # @!attribute billable_metric @@ -43,14 +39,10 @@ class Data < Orb::Internal::Type::BaseModel required :view_mode, enum: -> { Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode } - # @!parse - # # @param billable_metric [Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric] - # # @param usage [Array] - # # @param view_mode [Symbol, Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode] - # # - # def initialize(billable_metric:, usage:, view_mode:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(billable_metric:, usage:, view_mode:) + # @param billable_metric [Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric] + # @param usage [Array] + # @param view_mode [Symbol, Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode] # @see Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -64,13 +56,9 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end class Usage < Orb::Internal::Type::BaseModel @@ -89,14 +77,10 @@ class Usage < Orb::Internal::Type::BaseModel # @return [Time] required :timeframe_start, Time - # @!parse - # # @param quantity [Float] - # # @param timeframe_end [Time] - # # @param timeframe_start [Time] - # # - # def initialize(quantity:, timeframe_end:, timeframe_start:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(quantity:, timeframe_end:, timeframe_start:) + # @param quantity [Float] + # @param timeframe_end [Time] + # @param timeframe_start [Time] end # @see Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data#view_mode @@ -106,11 +90,8 @@ module ViewMode PERIODIC = :periodic CUMULATIVE = :cumulative - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -127,13 +108,9 @@ class GroupedSubscriptionUsage < Orb::Internal::Type::BaseModel # @return [Orb::Models::PaginationMetadata, nil] optional :pagination_metadata, -> { Orb::Models::PaginationMetadata }, nil?: true - # @!parse - # # @param data [Array] - # # @param pagination_metadata [Orb::Models::PaginationMetadata, nil] - # # - # def initialize(data:, pagination_metadata: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(data:, pagination_metadata: nil) + # @param data [Array] + # @param pagination_metadata [Orb::Models::PaginationMetadata, nil] class Data < Orb::Internal::Type::BaseModel # @!attribute billable_metric @@ -158,15 +135,11 @@ class Data < Orb::Internal::Type::BaseModel # @return [Symbol, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode] required :view_mode, enum: -> { Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode } - # @!parse - # # @param billable_metric [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric] - # # @param metric_group [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup] - # # @param usage [Array] - # # @param view_mode [Symbol, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode] - # # - # def initialize(billable_metric:, metric_group:, usage:, view_mode:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(billable_metric:, metric_group:, usage:, view_mode:) + # @param billable_metric [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric] + # @param metric_group [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup] + # @param usage [Array] + # @param view_mode [Symbol, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode] # @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#billable_metric class BillableMetric < Orb::Internal::Type::BaseModel @@ -180,13 +153,9 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param id [String] - # # @param name [String] - # # - # def initialize(id:, name:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(id:, name:) + # @param id [String] + # @param name [String] end # @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#metric_group @@ -201,13 +170,9 @@ class MetricGroup < Orb::Internal::Type::BaseModel # @return [String] required :property_value, String - # @!parse - # # @param property_key [String] - # # @param property_value [String] - # # - # def initialize(property_key:, property_value:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(property_key:, property_value:) + # @param property_key [String] + # @param property_value [String] end class Usage < Orb::Internal::Type::BaseModel @@ -226,14 +191,10 @@ class Usage < Orb::Internal::Type::BaseModel # @return [Time] required :timeframe_start, Time - # @!parse - # # @param quantity [Float] - # # @param timeframe_end [Time] - # # @param timeframe_start [Time] - # # - # def initialize(quantity:, timeframe_end:, timeframe_start:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(quantity:, timeframe_end:, timeframe_start:) + # @param quantity [Float] + # @param timeframe_end [Time] + # @param timeframe_start [Time] end # @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#view_mode @@ -243,18 +204,14 @@ module ViewMode PERIODIC = :periodic CUMULATIVE = :cumulative - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end - # @!parse - # # @return [Array(Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage)] - # def self.variants; end + # @!method self.variants + # @return [Array(Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage)] end end end diff --git a/lib/orb/models/subscriptions.rb b/lib/orb/models/subscriptions.rb index 6b58730f..13580ca9 100644 --- a/lib/orb/models/subscriptions.rb +++ b/lib/orb/models/subscriptions.rb @@ -13,13 +13,9 @@ class SubscriptionsAPI < Orb::Internal::Type::BaseModel # @return [Orb::Models::PaginationMetadata] required :pagination_metadata, -> { Orb::Models::PaginationMetadata } - # @!parse - # # @param data [Array] - # # @param pagination_metadata [Orb::Models::PaginationMetadata] - # # - # def initialize(data:, pagination_metadata:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(data:, pagination_metadata:) + # @param data [Array] + # @param pagination_metadata [Orb::Models::PaginationMetadata] end end end diff --git a/lib/orb/models/top_level_ping_params.rb b/lib/orb/models/top_level_ping_params.rb index 7b019dd5..cc91d056 100644 --- a/lib/orb/models/top_level_ping_params.rb +++ b/lib/orb/models/top_level_ping_params.rb @@ -4,16 +4,11 @@ module Orb module Models # @see Orb::Resources::TopLevel#ping class TopLevelPingParams < Orb::Internal::Type::BaseModel - # @!parse - # extend Orb::Internal::Type::RequestParameters::Converter + extend Orb::Internal::Type::RequestParameters::Converter include Orb::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/orb/models/top_level_ping_response.rb b/lib/orb/models/top_level_ping_response.rb index eb5a202a..2c2bac33 100644 --- a/lib/orb/models/top_level_ping_response.rb +++ b/lib/orb/models/top_level_ping_response.rb @@ -9,12 +9,8 @@ class TopLevelPingResponse < Orb::Internal::Type::BaseModel # @return [String] required :response, String - # @!parse - # # @param response [String] - # # - # def initialize(response:, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(response:) + # @param response [String] end end end diff --git a/lib/orb/models/trial_discount.rb b/lib/orb/models/trial_discount.rb index df8a6de4..c9356939 100644 --- a/lib/orb/models/trial_discount.rb +++ b/lib/orb/models/trial_discount.rb @@ -32,25 +32,20 @@ class TrialDiscount < Orb::Internal::Type::BaseModel # @return [Float, nil] optional :trial_percentage_discount, Float, nil?: true - # @!parse - # # @param applies_to_price_ids [Array] - # # @param discount_type [Symbol, Orb::Models::TrialDiscount::DiscountType] - # # @param reason [String, nil] - # # @param trial_amount_discount [String, nil] - # # @param trial_percentage_discount [Float, nil] - # # - # def initialize( - # applies_to_price_ids:, - # discount_type:, - # reason: nil, - # trial_amount_discount: nil, - # trial_percentage_discount: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, discount_type:, reason: nil, trial_amount_discount: nil, trial_percentage_discount: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::TrialDiscount} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this discount applies to. For plan/plan phase discounts, + # ... + # + # @param discount_type [Symbol, Orb::Models::TrialDiscount::DiscountType] + # + # @param reason [String, nil] + # + # @param trial_amount_discount [String, nil] Only available if discount_type is `trial` + # + # @param trial_percentage_discount [Float, nil] Only available if discount_type is `trial` # @see Orb::Models::TrialDiscount#discount_type module DiscountType @@ -58,11 +53,8 @@ module DiscountType TRIAL = :trial - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/models/usage_discount.rb b/lib/orb/models/usage_discount.rb index c0c43ff3..3a5bfc2d 100644 --- a/lib/orb/models/usage_discount.rb +++ b/lib/orb/models/usage_discount.rb @@ -27,15 +27,19 @@ class UsageDiscount < Orb::Internal::Type::BaseModel # @return [String, nil] optional :reason, String, nil?: true - # @!parse - # # @param applies_to_price_ids [Array] - # # @param discount_type [Symbol, Orb::Models::UsageDiscount::DiscountType] - # # @param usage_discount [Float] - # # @param reason [String, nil] - # # - # def initialize(applies_to_price_ids:, discount_type:, usage_discount:, reason: nil, **) = super - - # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + # @!method initialize(applies_to_price_ids:, discount_type:, usage_discount:, reason: nil) + # Some parameter documentations has been truncated, see + # {Orb::Models::UsageDiscount} for more details. + # + # @param applies_to_price_ids [Array] List of price_ids that this discount applies to. For plan/plan phase discounts, + # ... + # + # @param discount_type [Symbol, Orb::Models::UsageDiscount::DiscountType] + # + # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc + # ... + # + # @param reason [String, nil] # @see Orb::Models::UsageDiscount#discount_type module DiscountType @@ -43,11 +47,8 @@ module DiscountType USAGE = :usage - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/orb/request_options.rb b/lib/orb/request_options.rb index c30ac87b..eb0d8063 100644 --- a/lib/orb/request_options.rb +++ b/lib/orb/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/orb/resources/alerts.rb b/lib/orb/resources/alerts.rb index 8f41716e..f3782696 100644 --- a/lib/orb/resources/alerts.rb +++ b/lib/orb/resources/alerts.rb @@ -27,7 +27,9 @@ def retrieve(alert_id, params = {}) # @overload update(alert_configuration_id, thresholds:, request_options: {}) # # @param alert_configuration_id [String] - # @param thresholds [Array] + # + # @param thresholds [Array] The thresholds that define the values at which the alert will be triggered. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Alert] @@ -44,6 +46,9 @@ def update(alert_configuration_id, params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::AlertListParams} for more details. + # # This endpoint returns a list of alerts within Orb. # # The request must specify one of `customer_id`, `external_customer_id`, or @@ -59,14 +64,24 @@ def update(alert_configuration_id, params) # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, subscription_id: nil, request_options: {}) # # @param created_at_gt [Time, nil] + # # @param created_at_gte [Time, nil] + # # @param created_at_lt [Time, nil] + # # @param created_at_lte [Time, nil] - # @param cursor [String, nil] - # @param customer_id [String, nil] - # @param external_customer_id [String, nil] - # @param limit [Integer] - # @param subscription_id [String, nil] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param customer_id [String, nil] Fetch alerts scoped to this customer_id + # + # @param external_customer_id [String, nil] Fetch alerts scoped to this external_customer_id + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param subscription_id [String, nil] Fetch alerts scoped to this subscription_id + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] @@ -101,9 +116,13 @@ def list(params = {}) # @overload create_for_customer(customer_id, currency:, type:, thresholds: nil, request_options: {}) # # @param customer_id [String] - # @param currency [String] - # @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] - # @param thresholds [Array, nil] + # + # @param currency [String] The case sensitive currency or custom pricing unit to use for this alert. + # + # @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type. + # + # @param thresholds [Array, nil] The thresholds that define the values at which the alert will be triggered. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Alert] @@ -132,9 +151,13 @@ def create_for_customer(customer_id, params) # @overload create_for_external_customer(external_customer_id, currency:, type:, thresholds: nil, request_options: {}) # # @param external_customer_id [String] - # @param currency [String] - # @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] - # @param thresholds [Array, nil] + # + # @param currency [String] The case sensitive currency or custom pricing unit to use for this alert. + # + # @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type. + # + # @param thresholds [Array, nil] The thresholds that define the values at which the alert will be triggered. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Alert] @@ -166,9 +189,13 @@ def create_for_external_customer(external_customer_id, params) # @overload create_for_subscription(subscription_id, thresholds:, type:, metric_id: nil, request_options: {}) # # @param subscription_id [String] - # @param thresholds [Array] - # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] - # @param metric_id [String, nil] + # + # @param thresholds [Array] The thresholds that define the values at which the alert will be triggered. + # + # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type. + # + # @param metric_id [String, nil] The metric to track usage for. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Alert] @@ -192,7 +219,9 @@ def create_for_subscription(subscription_id, params) # @overload disable(alert_configuration_id, subscription_id: nil, request_options: {}) # # @param alert_configuration_id [String] - # @param subscription_id [String, nil] + # + # @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Alert] @@ -216,7 +245,9 @@ def disable(alert_configuration_id, params = {}) # @overload enable(alert_configuration_id, subscription_id: nil, request_options: {}) # # @param alert_configuration_id [String] - # @param subscription_id [String, nil] + # + # @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Alert] diff --git a/lib/orb/resources/coupons.rb b/lib/orb/resources/coupons.rb index 1ea7e2d3..8d146777 100644 --- a/lib/orb/resources/coupons.rb +++ b/lib/orb/resources/coupons.rb @@ -6,15 +6,24 @@ class Coupons # @return [Orb::Resources::Coupons::Subscriptions] attr_reader :subscriptions + # Some parameter documentations has been truncated, see + # {Orb::Models::CouponCreateParams} for more details. + # # This endpoint allows the creation of coupons, which can then be redeemed at # subscription creation or plan change. # # @overload create(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {}) # # @param discount [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount] - # @param redemption_code [String] - # @param duration_in_months [Integer, nil] - # @param max_redemptions [Integer, nil] + # + # @param redemption_code [String] This string can be used to redeem this coupon for a given subscription. + # + # @param duration_in_months [Integer, nil] This allows for a coupon's discount to apply for a limited time (determined in m + # ... + # + # @param max_redemptions [Integer, nil] The maximum number of redemptions allowed for this coupon before it is exhausted + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Coupon] @@ -31,6 +40,9 @@ def create(params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::CouponListParams} for more details. + # # This endpoint returns a list of all coupons for an account in a list format. # # The list of coupons is ordered starting from the most recently created coupon. @@ -40,10 +52,16 @@ def create(params) # # @overload list(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {}) # - # @param cursor [String, nil] - # @param limit [Integer] - # @param redemption_code [String, nil] - # @param show_archived [Boolean, nil] + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param redemption_code [String, nil] Filter to coupons matching this redemption code. + # + # @param show_archived [Boolean, nil] Show archived coupons as well (by default, this endpoint only returns active cou + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] diff --git a/lib/orb/resources/coupons/subscriptions.rb b/lib/orb/resources/coupons/subscriptions.rb index 0107f4cd..90443b38 100644 --- a/lib/orb/resources/coupons/subscriptions.rb +++ b/lib/orb/resources/coupons/subscriptions.rb @@ -4,6 +4,9 @@ module Orb module Resources class Coupons class Subscriptions + # Some parameter documentations has been truncated, see + # {Orb::Models::Coupons::SubscriptionListParams} for more details. + # # This endpoint returns a list of all subscriptions that have redeemed a given # coupon as a [paginated](/api-reference/pagination) list, ordered starting from # the most recently created subscription. For a full discussion of the @@ -12,8 +15,12 @@ class Subscriptions # @overload list(coupon_id, cursor: nil, limit: nil, request_options: {}) # # @param coupon_id [String] - # @param cursor [String, nil] - # @param limit [Integer] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] diff --git a/lib/orb/resources/credit_notes.rb b/lib/orb/resources/credit_notes.rb index 835b9e9d..9308325e 100644 --- a/lib/orb/resources/credit_notes.rb +++ b/lib/orb/resources/credit_notes.rb @@ -9,8 +9,11 @@ class CreditNotes # @overload create(line_items:, memo: nil, reason: nil, request_options: {}) # # @param line_items [Array] - # @param memo [String, nil] - # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] + # + # @param memo [String, nil] An optional memo to attach to the credit note. + # + # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::CreditNote] @@ -27,6 +30,9 @@ def create(params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::CreditNoteListParams} for more details. + # # Get a paginated list of CreditNotes. Users can also filter by customer_id, # subscription_id, or external_customer_id. The credit notes will be returned in # reverse chronological order by `creation_time`. @@ -34,11 +40,18 @@ def create(params) # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {}) # # @param created_at_gt [Time, nil] + # # @param created_at_gte [Time, nil] + # # @param created_at_lt [Time, nil] + # # @param created_at_lte [Time, nil] - # @param cursor [String, nil] - # @param limit [Integer] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] diff --git a/lib/orb/resources/customers.rb b/lib/orb/resources/customers.rb index c7932ea5..28d563cc 100644 --- a/lib/orb/resources/customers.rb +++ b/lib/orb/resources/customers.rb @@ -12,6 +12,9 @@ class Customers # @return [Orb::Resources::Customers::BalanceTransactions] attr_reader :balance_transactions + # Some parameter documentations has been truncated, see + # {Orb::Models::CustomerCreateParams} for more details. + # # This operation is used to create an Orb customer, who is party to the core # billing relationship. See [Customer](/core-concepts##customer) for an overview # of the customer resource. @@ -27,24 +30,52 @@ class Customers # # @overload create(email:, name:, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, timezone: nil, request_options: {}) # - # @param email [String] - # @param name [String] + # @param email [String] A valid customer email, to be used for notifications. When Orb triggers payment + # ... + # + # @param name [String] The full name of the customer + # # @param accounting_sync_configuration [Orb::Models::CustomerCreateParams::AccountingSyncConfiguration, nil] - # @param additional_emails [Array, nil] - # @param auto_collection [Boolean, nil] + # + # @param additional_emails [Array, nil] Additional email addresses for this customer. If populated, these email addresse + # ... + # + # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch + # ... + # # @param billing_address [Orb::Models::CustomerCreateParams::BillingAddress, nil] - # @param currency [String, nil] + # + # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not + # ... + # # @param email_delivery [Boolean, nil] - # @param external_customer_id [String, nil] - # @param hierarchy [Orb::Models::CustomerCreateParams::Hierarchy, nil] - # @param metadata [Hash{Symbol=>String, nil}, nil] - # @param payment_provider [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil] - # @param payment_provider_id [String, nil] + # + # @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst + # ... + # + # @param hierarchy [Orb::Models::CustomerCreateParams::Hierarchy, nil] The hierarchical relationships for this customer. + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param payment_provider [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe + # ... + # + # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i + # ... + # # @param reporting_configuration [Orb::Models::CustomerCreateParams::ReportingConfiguration, nil] + # # @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil] + # # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration, nil] - # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] - # @param timezone [String, nil] + # + # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad + # ... + # + # @param timezone [String, nil] A timezone identifier from the IANA timezone database, such as `"America/Los_Ang + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customer] @@ -61,6 +92,9 @@ def create(params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::CustomerUpdateParams} for more details. + # # This endpoint can be used to update the `payment_provider`, # `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`, # `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and @@ -70,23 +104,49 @@ def create(params) # @overload update(customer_id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {}) # # @param customer_id [String] + # # @param accounting_sync_configuration [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil] - # @param additional_emails [Array, nil] - # @param auto_collection [Boolean, nil] + # + # @param additional_emails [Array, nil] Additional email addresses for this customer. If populated, these email addresse + # ... + # + # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch + # ... + # # @param billing_address [Orb::Models::CustomerUpdateParams::BillingAddress, nil] - # @param currency [String, nil] - # @param email [String, nil] + # + # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not + # ... + # + # @param email [String, nil] A valid customer email, to be used for invoicing and notifications. + # # @param email_delivery [Boolean, nil] - # @param external_customer_id [String, nil] - # @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil] - # @param metadata [Hash{Symbol=>String, nil}, nil] - # @param name [String, nil] - # @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil] - # @param payment_provider_id [String, nil] + # + # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no + # ... + # + # @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer. + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param name [String, nil] The full name of the customer + # + # @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe + # ... + # + # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i + # ... + # # @param reporting_configuration [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil] + # # @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil] + # # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration, nil] - # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] + # + # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customer] @@ -103,6 +163,9 @@ def update(customer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::CustomerListParams} for more details. + # # This endpoint returns a list of all customers for an account. The list of # customers is ordered starting from the most recently created customer. This # endpoint follows Orb's @@ -113,11 +176,18 @@ def update(customer_id, params = {}) # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {}) # # @param created_at_gt [Time, nil] + # # @param created_at_gte [Time, nil] + # # @param created_at_lt [Time, nil] + # # @param created_at_lte [Time, nil] - # @param cursor [String, nil] - # @param limit [Integer] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] @@ -271,6 +341,9 @@ def sync_payment_methods_from_gateway_by_external_customer_id(external_customer_ ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::CustomerUpdateByExternalIDParams} for more details. + # # This endpoint is used to update customer details given an `external_customer_id` # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the # resource and semantics of this endpoint exactly mirror @@ -279,23 +352,49 @@ def sync_payment_methods_from_gateway_by_external_customer_id(external_customer_ # @overload update_by_external_id(id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {}) # # @param id [String] + # # @param accounting_sync_configuration [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil] - # @param additional_emails [Array, nil] - # @param auto_collection [Boolean, nil] + # + # @param additional_emails [Array, nil] Additional email addresses for this customer. If populated, these email addresse + # ... + # + # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch + # ... + # # @param billing_address [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil] - # @param currency [String, nil] - # @param email [String, nil] + # + # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not + # ... + # + # @param email [String, nil] A valid customer email, to be used for invoicing and notifications. + # # @param email_delivery [Boolean, nil] - # @param external_customer_id [String, nil] - # @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil] - # @param metadata [Hash{Symbol=>String, nil}, nil] - # @param name [String, nil] - # @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] - # @param payment_provider_id [String, nil] + # + # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no + # ... + # + # @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer. + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param name [String, nil] The full name of the customer + # + # @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe + # ... + # + # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i + # ... + # # @param reporting_configuration [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil] + # # @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil] + # # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration, nil] - # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] + # + # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customer] diff --git a/lib/orb/resources/customers/balance_transactions.rb b/lib/orb/resources/customers/balance_transactions.rb index 99112b00..f8c96c54 100644 --- a/lib/orb/resources/customers/balance_transactions.rb +++ b/lib/orb/resources/customers/balance_transactions.rb @@ -10,9 +10,13 @@ class BalanceTransactions # @overload create(customer_id, amount:, type:, description: nil, request_options: {}) # # @param customer_id [String] + # # @param amount [String] + # # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type] - # @param description [String, nil] + # + # @param description [String, nil] An optional description that can be specified around this entry. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customers::BalanceTransactionCreateResponse] @@ -29,6 +33,9 @@ def create(customer_id, params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::BalanceTransactionListParams} for more details. + # # ## The customer balance # # The customer balance is an amount in the customer's currency, which Orb @@ -61,12 +68,20 @@ def create(customer_id, params) # @overload list(customer_id, cursor: nil, limit: nil, operation_time_gt: nil, operation_time_gte: nil, operation_time_lt: nil, operation_time_lte: nil, request_options: {}) # # @param customer_id [String] - # @param cursor [String, nil] - # @param limit [Integer] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param operation_time_gt [Time, nil] + # # @param operation_time_gte [Time, nil] + # # @param operation_time_lt [Time, nil] + # # @param operation_time_lte [Time, nil] + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] diff --git a/lib/orb/resources/customers/costs.rb b/lib/orb/resources/customers/costs.rb index 4378122e..55631fc4 100644 --- a/lib/orb/resources/customers/costs.rb +++ b/lib/orb/resources/customers/costs.rb @@ -4,6 +4,9 @@ module Orb module Resources class Customers class Costs + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::CostListParams} for more details. + # # This endpoint is used to fetch a day-by-day snapshot of a customer's costs in # Orb, calculated by applying pricing information to the underlying usage (see the # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage) @@ -125,10 +128,16 @@ class Costs # @overload list(customer_id, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) # # @param customer_id [String] - # @param currency [String, nil] - # @param timeframe_end [Time, nil] - # @param timeframe_start [Time, nil] - # @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] + # + # @param currency [String, nil] The currency or custom pricing unit to use. + # + # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`. + # + # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`. + # + # @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customers::CostListResponse] @@ -145,6 +154,9 @@ def list(customer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::CostListByExternalIDParams} for more details. + # # This endpoint is used to fetch a day-by-day snapshot of a customer's costs in # Orb, calculated by applying pricing information to the underlying usage (see the # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage) @@ -266,10 +278,16 @@ def list(customer_id, params = {}) # @overload list_by_external_id(external_customer_id, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) # # @param external_customer_id [String] - # @param currency [String, nil] - # @param timeframe_end [Time, nil] - # @param timeframe_start [Time, nil] - # @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] + # + # @param currency [String, nil] The currency or custom pricing unit to use. + # + # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`. + # + # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`. + # + # @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customers::CostListByExternalIDResponse] diff --git a/lib/orb/resources/customers/credits.rb b/lib/orb/resources/customers/credits.rb index aadf6ad3..09a030df 100644 --- a/lib/orb/resources/customers/credits.rb +++ b/lib/orb/resources/customers/credits.rb @@ -10,6 +10,9 @@ class Credits # @return [Orb::Resources::Customers::Credits::TopUps] attr_reader :top_ups + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::CreditListParams} for more details. + # # Returns a paginated list of unexpired, non-zero credit blocks for a customer. # # If `include_all_blocks` is set to `true`, all credit blocks (including expired @@ -21,10 +24,17 @@ class Credits # @overload list(customer_id, currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}) # # @param customer_id [String] - # @param currency [String, nil] - # @param cursor [String, nil] - # @param include_all_blocks [Boolean] - # @param limit [Integer] + # + # @param currency [String, nil] The ledger currency or custom pricing unit to use. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] @@ -42,6 +52,9 @@ def list(customer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::CreditListByExternalIDParams} for more details. + # # Returns a paginated list of unexpired, non-zero credit blocks for a customer. # # If `include_all_blocks` is set to `true`, all credit blocks (including expired @@ -53,10 +66,17 @@ def list(customer_id, params = {}) # @overload list_by_external_id(external_customer_id, currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}) # # @param external_customer_id [String] - # @param currency [String, nil] - # @param cursor [String, nil] - # @param include_all_blocks [Boolean] - # @param limit [Integer] + # + # @param currency [String, nil] The ledger currency or custom pricing unit to use. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] diff --git a/lib/orb/resources/customers/credits/ledger.rb b/lib/orb/resources/customers/credits/ledger.rb index 60f2f474..485e5dc4 100644 --- a/lib/orb/resources/customers/credits/ledger.rb +++ b/lib/orb/resources/customers/credits/ledger.rb @@ -5,6 +5,9 @@ module Resources class Customers class Credits class Ledger + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListParams} for more details. + # # The credits ledger provides _auditing_ functionality over Orb's credits system # with a list of actions that have taken place to modify a customer's credit # balance. This [paginated endpoint](/api-reference/pagination) lists these @@ -90,16 +93,28 @@ class Ledger # @overload list(customer_id, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {}) # # @param customer_id [String] + # # @param created_at_gt [Time, nil] + # # @param created_at_gte [Time, nil] + # # @param created_at_lt [Time, nil] + # # @param created_at_lte [Time, nil] - # @param currency [String, nil] - # @param cursor [String, nil] + # + # @param currency [String, nil] The ledger currency or custom pricing unit to use. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus, nil] + # # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType, nil] - # @param limit [Integer] + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param minimum_amount [String, nil] + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] @@ -122,6 +137,9 @@ def list(customer_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryParams} for more details. + # # This endpoint allows you to create a new ledger entry for a specified customer's # balance. This can be used to increment balance, deduct credits, and change the # expiry date of existing credits. @@ -236,18 +254,39 @@ def list(customer_id, params = {}) # @overload create_entry(customer_id, amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {}) # # @param customer_id [String] - # @param amount [Float] + # + # @param amount [Float] The number of credits to effect. Note that this is required for increment, decre + # ... + # # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType] - # @param expiry_date [Time, nil] - # @param target_expiry_date [Date] - # @param block_id [String] - # @param currency [String, nil] - # @param description [String, nil] - # @param effective_date [Time, nil] - # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] - # @param metadata [Hash{Symbol=>String, nil}, nil] - # @param per_unit_cost_basis [String, nil] - # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] + # + # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire + # + # @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot + # ... + # + # @param block_id [String] The ID of the block to reverse a decrement from. + # + # @param currency [String, nil] The currency or custom pricing unit to use for this ledger entry. If this is a r + # ... + # + # @param description [String, nil] Optional metadata that can be specified when adding ledger results via the API. + # ... + # + # @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai + # ... + # + # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur + # ... + # + # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry] @@ -264,6 +303,10 @@ def create_entry(customer_id, params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams} for more + # details. + # # This endpoint allows you to create a new ledger entry for a specified customer's # balance. This can be used to increment balance, deduct credits, and change the # expiry date of existing credits. @@ -378,18 +421,39 @@ def create_entry(customer_id, params) # @overload create_entry_by_external_id(external_customer_id, amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {}) # # @param external_customer_id [String] - # @param amount [Float] + # + # @param amount [Float] The number of credits to effect. Note that this is required for increment, decre + # ... + # # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType] - # @param expiry_date [Time, nil] - # @param target_expiry_date [Date] - # @param block_id [String] - # @param currency [String, nil] - # @param description [String, nil] - # @param effective_date [Time, nil] - # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] - # @param metadata [Hash{Symbol=>String, nil}, nil] - # @param per_unit_cost_basis [String, nil] - # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] + # + # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire + # + # @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot + # ... + # + # @param block_id [String] The ID of the block to reverse a decrement from. + # + # @param currency [String, nil] The currency or custom pricing unit to use for this ledger entry. If this is a r + # ... + # + # @param description [String, nil] Optional metadata that can be specified when adding ledger results via the API. + # ... + # + # @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai + # ... + # + # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur + # ... + # + # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry] @@ -407,6 +471,10 @@ def create_entry_by_external_id(external_customer_id, params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::LedgerListByExternalIDParams} for more + # details. + # # The credits ledger provides _auditing_ functionality over Orb's credits system # with a list of actions that have taken place to modify a customer's credit # balance. This [paginated endpoint](/api-reference/pagination) lists these @@ -492,16 +560,28 @@ def create_entry_by_external_id(external_customer_id, params) # @overload list_by_external_id(external_customer_id, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {}) # # @param external_customer_id [String] + # # @param created_at_gt [Time, nil] + # # @param created_at_gte [Time, nil] + # # @param created_at_lt [Time, nil] + # # @param created_at_lte [Time, nil] - # @param currency [String, nil] - # @param cursor [String, nil] + # + # @param currency [String, nil] The ledger currency or custom pricing unit to use. + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil] + # # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil] - # @param limit [Integer] + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param minimum_amount [String, nil] + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] diff --git a/lib/orb/resources/customers/credits/top_ups.rb b/lib/orb/resources/customers/credits/top_ups.rb index 7ca4a7af..b3f23a40 100644 --- a/lib/orb/resources/customers/credits/top_ups.rb +++ b/lib/orb/resources/customers/credits/top_ups.rb @@ -5,6 +5,9 @@ module Resources class Customers class Credits class TopUps + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpCreateParams} for more details. + # # This endpoint allows you to create a new top-up for a specified customer's # balance. While this top-up is active, the customer's balance will added in # increments of the specified amount whenever the balance reaches the specified @@ -16,14 +19,27 @@ class TopUps # @overload create(customer_id, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {}) # # @param customer_id [String] - # @param amount [String] - # @param currency [String] - # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings] - # @param per_unit_cost_basis [String] - # @param threshold [String] - # @param active_from [Time, nil] - # @param expires_after [Integer, nil] - # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] + # + # @param amount [String] The amount to increment when the threshold is reached. + # + # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo + # ... + # + # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings] Settings for invoices generated by triggered top-ups. + # + # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit. + # + # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this + # ... + # + # @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i + # ... + # + # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it + # ... + # + # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] The unit of expires_after. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customers::Credits::TopUpCreateResponse] @@ -40,13 +56,20 @@ def create(customer_id, params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpListParams} for more details. + # # List top-ups # # @overload list(customer_id, cursor: nil, limit: nil, request_options: {}) # # @param customer_id [String] - # @param cursor [String, nil] - # @param limit [Integer] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] @@ -90,6 +113,10 @@ def delete(top_up_id, params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams} for more + # details. + # # This endpoint allows you to create a new top-up for a specified customer's # balance. While this top-up is active, the customer's balance will added in # increments of the specified amount whenever the balance reaches the specified @@ -101,14 +128,27 @@ def delete(top_up_id, params) # @overload create_by_external_id(external_customer_id, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {}) # # @param external_customer_id [String] - # @param amount [String] - # @param currency [String] - # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] - # @param per_unit_cost_basis [String] - # @param threshold [String] - # @param active_from [Time, nil] - # @param expires_after [Integer, nil] - # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] + # + # @param amount [String] The amount to increment when the threshold is reached. + # + # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo + # ... + # + # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] Settings for invoices generated by triggered top-ups. + # + # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit. + # + # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this + # ... + # + # @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i + # ... + # + # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it + # ... + # + # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] The unit of expires_after. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse] @@ -155,13 +195,20 @@ def delete_by_external_id(top_up_id, params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::Customers::Credits::TopUpListByExternalIDParams} for more details. + # # List top-ups by external ID # # @overload list_by_external_id(external_customer_id, cursor: nil, limit: nil, request_options: {}) # # @param external_customer_id [String] - # @param cursor [String, nil] - # @param limit [Integer] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] diff --git a/lib/orb/resources/dimensional_price_groups.rb b/lib/orb/resources/dimensional_price_groups.rb index 764711ea..5ec2c65e 100644 --- a/lib/orb/resources/dimensional_price_groups.rb +++ b/lib/orb/resources/dimensional_price_groups.rb @@ -6,6 +6,9 @@ class DimensionalPriceGroups # @return [Orb::Resources::DimensionalPriceGroups::ExternalDimensionalPriceGroupID] attr_reader :external_dimensional_price_group_id + # Some parameter documentations has been truncated, see + # {Orb::Models::DimensionalPriceGroupCreateParams} for more details. + # # A dimensional price group is used to partition the result of a billable metric # by a set of dimensions. Prices in a price group must specify the parition used # to derive their usage. @@ -18,10 +21,16 @@ class DimensionalPriceGroups # @overload create(billable_metric_id:, dimensions:, name:, external_dimensional_price_group_id: nil, metadata: nil, request_options: {}) # # @param billable_metric_id [String] - # @param dimensions [Array] + # + # @param dimensions [Array] The set of keys (in order) used to disambiguate prices in the group. + # # @param name [String] + # # @param external_dimensional_price_group_id [String, nil] - # @param metadata [Hash{Symbol=>String, nil}, nil] + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::DimensionalPriceGroup] @@ -57,12 +66,18 @@ def retrieve(dimensional_price_group_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::DimensionalPriceGroupListParams} for more details. + # # List dimensional price groups # # @overload list(cursor: nil, limit: nil, request_options: {}) # - # @param cursor [String, nil] - # @param limit [Integer] + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] diff --git a/lib/orb/resources/events.rb b/lib/orb/resources/events.rb index f55004e4..5297e5db 100644 --- a/lib/orb/resources/events.rb +++ b/lib/orb/resources/events.rb @@ -9,6 +9,9 @@ class Events # @return [Orb::Resources::Events::Volume] attr_reader :volume + # Some parameter documentations has been truncated, see + # {Orb::Models::EventUpdateParams} for more details. + # # This endpoint is used to amend a single usage event with a given `event_id`. # `event_id` refers to the `idempotency_key` passed in during ingestion. The event # will maintain its existing `event_id` after the amendment. @@ -58,11 +61,20 @@ class Events # @overload update(event_id, event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {}) # # @param event_id [String] - # @param event_name [String] - # @param properties [Object] - # @param timestamp [Time] - # @param customer_id [String, nil] - # @param external_customer_id [String, nil] + # + # @param event_name [String] A name to meaningfully identify the action or event type. + # + # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo + # ... + # + # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen + # ... + # + # @param customer_id [String, nil] The Orb Customer identifier + # + # @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::EventUpdateResponse] @@ -137,6 +149,9 @@ def deprecate(event_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::EventIngestParams} for more details. + # # Orb's event ingestion model and API is designed around two core principles: # # 1. **Data fidelity**: The accuracy of your billing model depends on a robust @@ -344,9 +359,14 @@ def deprecate(event_id, params = {}) # # @overload ingest(events:, backfill_id: nil, debug: nil, request_options: {}) # - # @param events [Array] - # @param backfill_id [String, nil] - # @param debug [Boolean] + # @param events [Array] Body param: + # + # @param backfill_id [String, nil] Query param: If this ingestion request is part of a backfill, this parameter tie + # ... + # + # @param debug [Boolean] Query param: Flag to enable additional debug information in the endpoint respons + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::EventIngestResponse] @@ -365,6 +385,9 @@ def ingest(params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::EventSearchParams} for more details. + # # This endpoint returns a filtered set of events for an account in a # [paginated list format](/api-reference/pagination). # @@ -383,9 +406,15 @@ def ingest(params) # # @overload search(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {}) # - # @param event_ids [Array] - # @param timeframe_end [Time, nil] - # @param timeframe_start [Time, nil] + # @param event_ids [Array] This is an explicit array of IDs to filter by. Note that an event's ID is the id + # ... + # + # @param timeframe_end [Time, nil] The end of the timeframe, exclusive, in which to search events. If not specified + # ... + # + # @param timeframe_start [Time, nil] The start of the timeframe, inclusive, in which to search events. If not specifi + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::EventSearchResponse] diff --git a/lib/orb/resources/events/backfills.rb b/lib/orb/resources/events/backfills.rb index 4c842e79..57708a91 100644 --- a/lib/orb/resources/events/backfills.rb +++ b/lib/orb/resources/events/backfills.rb @@ -4,6 +4,9 @@ module Orb module Resources class Events class Backfills + # Some parameter documentations has been truncated, see + # {Orb::Models::Events::BackfillCreateParams} for more details. + # # Creating the backfill enables adding or replacing past events, even those that # are older than the ingestion grace period. Performing a backfill in Orb involves # 3 steps: @@ -44,13 +47,27 @@ class Backfills # # @overload create(timeframe_end:, timeframe_start:, close_time: nil, customer_id: nil, deprecation_filter: nil, external_customer_id: nil, replace_existing_events: nil, request_options: {}) # - # @param timeframe_end [Time] - # @param timeframe_start [Time] - # @param close_time [Time, nil] - # @param customer_id [String, nil] - # @param deprecation_filter [String, nil] - # @param external_customer_id [String, nil] - # @param replace_existing_events [Boolean] + # @param timeframe_end [Time] The (exclusive) end of the usage timeframe affected by this backfill. By default + # ... + # + # @param timeframe_start [Time] The (inclusive) start of the usage timeframe affected by this backfill. By defau + # ... + # + # @param close_time [Time, nil] The time at which no more events will be accepted for this backfill. The backfil + # ... + # + # @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. Omitting + # ... + # + # @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie + # ... + # + # @param external_customer_id [String, nil] The external customer ID of the customer to which this backfill is scoped. Omitt + # ... + # + # @param replace_existing_events [Boolean] If true, replaces all existing events in the timeframe with the newly ingested e + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Events::BackfillCreateResponse] @@ -67,6 +84,9 @@ def create(params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::Events::BackfillListParams} for more details. + # # This endpoint returns a list of all backfills in a list format. # # The list of backfills is ordered starting from the most recently created @@ -77,8 +97,11 @@ def create(params) # # @overload list(cursor: nil, limit: nil, request_options: {}) # - # @param cursor [String, nil] - # @param limit [Integer] + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] diff --git a/lib/orb/resources/events/volume.rb b/lib/orb/resources/events/volume.rb index dbc4b441..2daa572e 100644 --- a/lib/orb/resources/events/volume.rb +++ b/lib/orb/resources/events/volume.rb @@ -4,6 +4,9 @@ module Orb module Resources class Events class Volume + # Some parameter documentations has been truncated, see + # {Orb::Models::Events::VolumeListParams} for more details. + # # This endpoint returns the event volume for an account in a # [paginated list format](/api-reference/pagination). # @@ -20,10 +23,17 @@ class Volume # # @overload list(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {}) # - # @param timeframe_start [Time] - # @param cursor [String, nil] - # @param limit [Integer] - # @param timeframe_end [Time] + # @param timeframe_start [Time] The start of the timeframe, inclusive, in which to return event volume. All date + # ... + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param timeframe_end [Time] The end of the timeframe, exclusive, in which to return event volume. If not spe + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Events::EventVolumes] diff --git a/lib/orb/resources/invoice_line_items.rb b/lib/orb/resources/invoice_line_items.rb index 0f973aa4..55264add 100644 --- a/lib/orb/resources/invoice_line_items.rb +++ b/lib/orb/resources/invoice_line_items.rb @@ -3,17 +3,27 @@ module Orb module Resources class InvoiceLineItems + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceLineItemCreateParams} for more details. + # # This creates a one-off fixed fee invoice line item on an Invoice. This can only # be done for invoices that are in a `draft` status. # # @overload create(amount:, end_date:, invoice_id:, name:, quantity:, start_date:, request_options: {}) # - # @param amount [String] - # @param end_date [Date] - # @param invoice_id [String] - # @param name [String] - # @param quantity [Float] - # @param start_date [Date] + # @param amount [String] The total amount in the invoice's currency to add to the line item. + # + # @param end_date [Date] A date string to specify the line item's end date in the customer's timezone. + # + # @param invoice_id [String] The id of the Invoice to add this line item. + # + # @param name [String] The item name associated with this line item. If an item with the same name exis + # ... + # + # @param quantity [Float] The number of units on the line item + # + # @param start_date [Date] A date string to specify the line item's start date in the customer's timezone. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::InvoiceLineItemCreateResponse] diff --git a/lib/orb/resources/invoices.rb b/lib/orb/resources/invoices.rb index 5401a78d..8c978916 100644 --- a/lib/orb/resources/invoices.rb +++ b/lib/orb/resources/invoices.rb @@ -3,20 +3,40 @@ module Orb module Resources class Invoices + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceCreateParams} for more details. + # # This endpoint is used to create a one-off invoice for a customer. # # @overload create(currency:, invoice_date:, line_items:, net_terms:, customer_id: nil, discount: nil, external_customer_id: nil, memo: nil, metadata: nil, will_auto_issue: nil, request_options: {}) # - # @param currency [String] - # @param invoice_date [Time] + # @param currency [String] An ISO 4217 currency string. Must be the same as the customer's currency if it i + # ... + # + # @param invoice_date [Time] Optional invoice date to set. Must be in the past, if not set, `invoice_date` is + # ... + # # @param line_items [Array] - # @param net_terms [Integer] - # @param customer_id [String, nil] - # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] - # @param external_customer_id [String, nil] - # @param memo [String, nil] - # @param metadata [Hash{Symbol=>String, nil}, nil] - # @param will_auto_issue [Boolean] + # + # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic + # ... + # + # @param customer_id [String, nil] The id of the `Customer` to create this invoice for. One of `customer_id` and `e + # ... + # + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] An optional discount to attach to the invoice. + # + # @param external_customer_id [String, nil] The `external_customer_id` of the `Customer` to create this invoice for. One of + # ... + # + # @param memo [String, nil] An optional memo to attach to the invoice. + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param will_auto_issue [Boolean] When true, this invoice will be submitted for issuance upon creation. When false + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Invoice] @@ -33,6 +53,9 @@ def create(params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceUpdateParams} for more details. + # # This endpoint allows you to update the `metadata` property on an invoice. If you # pass null for the metadata value, it will clear any existing metadata for that # invoice. @@ -42,7 +65,10 @@ def create(params) # @overload update(invoice_id, metadata: nil, request_options: {}) # # @param invoice_id [String] - # @param metadata [Hash{Symbol=>String, nil}, nil] + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Invoice] @@ -59,6 +85,9 @@ def update(invoice_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceListParams} for more details. + # # This endpoint returns a list of all [`Invoice`](/core-concepts#invoice)s for an # account in a list format. # @@ -76,24 +105,45 @@ def update(invoice_id, params = {}) # @overload list(amount: nil, amount_gt: nil, amount_lt: nil, cursor: nil, customer_id: nil, date_type: nil, due_date: nil, due_date_window: nil, due_date_gt: nil, due_date_lt: nil, external_customer_id: nil, invoice_date_gt: nil, invoice_date_gte: nil, invoice_date_lt: nil, invoice_date_lte: nil, is_recurring: nil, limit: nil, status: nil, subscription_id: nil, request_options: {}) # # @param amount [String, nil] + # # @param amount_gt [String, nil] + # # @param amount_lt [String, nil] - # @param cursor [String, nil] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # # @param customer_id [String, nil] + # # @param date_type [Symbol, Orb::Models::InvoiceListParams::DateType, nil] + # # @param due_date [Date, nil] - # @param due_date_window [String, nil] + # + # @param due_date_window [String, nil] Filters invoices by their due dates within a specific time range in the past. Sp + # ... + # # @param due_date_gt [Date, nil] + # # @param due_date_lt [Date, nil] + # # @param external_customer_id [String, nil] + # # @param invoice_date_gt [Time, nil] + # # @param invoice_date_gte [Time, nil] + # # @param invoice_date_lt [Time, nil] + # # @param invoice_date_lte [Time, nil] + # # @param is_recurring [Boolean, nil] - # @param limit [Integer] + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param status [Array, nil] + # # @param subscription_id [String, nil] + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] @@ -163,6 +213,9 @@ def fetch_upcoming(params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::InvoiceIssueParams} for more details. + # # This endpoint allows an eligible invoice to be issued manually. This is only # possible with invoices where status is `draft`, `will_auto_issue` is false, and # an `eligible_to_issue_at` is a time in the past. Issuing an invoice could @@ -173,7 +226,10 @@ def fetch_upcoming(params) # @overload issue(invoice_id, synchronous: nil, request_options: {}) # # @param invoice_id [String] - # @param synchronous [Boolean] + # + # @param synchronous [Boolean] If true, the invoice will be issued synchronously. If false, the invoice will be + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Invoice] @@ -196,9 +252,13 @@ def issue(invoice_id, params = {}) # @overload mark_paid(invoice_id, payment_received_date:, external_id: nil, notes: nil, request_options: {}) # # @param invoice_id [String] - # @param payment_received_date [Date] - # @param external_id [String, nil] - # @param notes [String, nil] + # + # @param payment_received_date [Date] A date string to specify the date of the payment. + # + # @param external_id [String, nil] An optional external ID to associate with the payment. + # + # @param notes [String, nil] An optional note to associate with the payment. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Invoice] diff --git a/lib/orb/resources/items.rb b/lib/orb/resources/items.rb index ad64482a..9b4289b5 100644 --- a/lib/orb/resources/items.rb +++ b/lib/orb/resources/items.rb @@ -7,7 +7,8 @@ class Items # # @overload create(name:, request_options: {}) # - # @param name [String] + # @param name [String] The name of the item. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Item] @@ -41,13 +42,19 @@ def update(item_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::ItemListParams} for more details. + # # This endpoint returns a list of all Items, ordered in descending order by # creation time. # # @overload list(cursor: nil, limit: nil, request_options: {}) # - # @param cursor [String, nil] - # @param limit [Integer] + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] diff --git a/lib/orb/resources/metrics.rb b/lib/orb/resources/metrics.rb index 55c071f3..e0eb4d83 100644 --- a/lib/orb/resources/metrics.rb +++ b/lib/orb/resources/metrics.rb @@ -3,17 +3,26 @@ module Orb module Resources class Metrics + # Some parameter documentations has been truncated, see + # {Orb::Models::MetricCreateParams} for more details. + # # This endpoint is used to create a [metric](/core-concepts###metric) using a SQL # string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a # description of constructing SQL queries with examples. # # @overload create(description:, item_id:, name:, sql:, metadata: nil, request_options: {}) # - # @param description [String, nil] - # @param item_id [String] - # @param name [String] - # @param sql [String] - # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param description [String, nil] A description of the metric. + # + # @param item_id [String] The id of the item + # + # @param name [String] The name of the metric. + # + # @param sql [String] A sql string defining the metric. + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::BillableMetric] @@ -30,6 +39,9 @@ def create(params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::MetricUpdateParams} for more details. + # # This endpoint allows you to update the `metadata` property on a metric. If you # pass `null` for the metadata value, it will clear any existing metadata for that # invoice. @@ -37,7 +49,10 @@ def create(params) # @overload update(metric_id, metadata: nil, request_options: {}) # # @param metric_id [String] - # @param metadata [Hash{Symbol=>String, nil}, nil] + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::BillableMetric] @@ -54,6 +69,9 @@ def update(metric_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::MetricListParams} for more details. + # # This endpoint is used to fetch [metric](/core-concepts##metric) details given a # metric identifier. It returns information about the metrics including its name, # description, and item. @@ -61,11 +79,18 @@ def update(metric_id, params = {}) # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {}) # # @param created_at_gt [Time, nil] + # # @param created_at_gte [Time, nil] + # # @param created_at_lt [Time, nil] + # # @param created_at_lte [Time, nil] - # @param cursor [String, nil] - # @param limit [Integer] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] diff --git a/lib/orb/resources/plans.rb b/lib/orb/resources/plans.rb index b4defc43..893f7b5b 100644 --- a/lib/orb/resources/plans.rb +++ b/lib/orb/resources/plans.rb @@ -6,18 +6,35 @@ class Plans # @return [Orb::Resources::Plans::ExternalPlanID] attr_reader :external_plan_id + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanCreateParams} for more details. + # # This endpoint allows creation of plans including their prices. # # @overload create(currency:, name:, prices:, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, status: nil, request_options: {}) # - # @param currency [String] + # @param currency [String] An ISO 4217 currency string for invoices generated by subscriptions on this plan + # ... + # # @param name [String] - # @param prices [Array] - # @param default_invoice_memo [String, nil] + # + # @param prices [Array] Prices for this plan. If the plan has phases, this includes prices across all ph + # ... + # + # @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal. + # ... + # # @param external_plan_id [String, nil] - # @param metadata [Hash{Symbol=>String, nil}, nil] - # @param net_terms [Integer, nil] - # @param status [Symbol, Orb::Models::PlanCreateParams::Status] + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d + # ... + # + # @param status [Symbol, Orb::Models::PlanCreateParams::Status] The status of the plan to create (either active or draft). If not specified, thi + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Plan] @@ -28,6 +45,9 @@ def create(params) @client.request(method: :post, path: "plans", body: parsed, model: Orb::Models::Plan, options: options) end + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanUpdateParams} for more details. + # # This endpoint can be used to update the `external_plan_id`, and `metadata` of an # existing plan. # @@ -36,8 +56,13 @@ def create(params) # @overload update(plan_id, external_plan_id: nil, metadata: nil, request_options: {}) # # @param plan_id [String] - # @param external_plan_id [String, nil] - # @param metadata [Hash{Symbol=>String, nil}, nil] + # + # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Plan] @@ -54,6 +79,9 @@ def update(plan_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::PlanListParams} for more details. + # # This endpoint returns a list of all [plans](/core-concepts#plan-and-price) for # an account in a list format. The list of plans is ordered starting from the most # recently created plan. The response also includes @@ -63,12 +91,20 @@ def update(plan_id, params = {}) # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, status: nil, request_options: {}) # # @param created_at_gt [Time, nil] + # # @param created_at_gte [Time, nil] + # # @param created_at_lt [Time, nil] + # # @param created_at_lte [Time, nil] - # @param cursor [String, nil] - # @param limit [Integer] - # @param status [Symbol, Orb::Models::PlanListParams::Status] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # + # @param status [Symbol, Orb::Models::PlanListParams::Status] The plan status to filter to ('active', 'archived', or 'draft'). + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] diff --git a/lib/orb/resources/plans/external_plan_id.rb b/lib/orb/resources/plans/external_plan_id.rb index 7302f3c5..aecdbeb3 100644 --- a/lib/orb/resources/plans/external_plan_id.rb +++ b/lib/orb/resources/plans/external_plan_id.rb @@ -4,6 +4,9 @@ module Orb module Resources class Plans class ExternalPlanID + # Some parameter documentations has been truncated, see + # {Orb::Models::Plans::ExternalPlanIDUpdateParams} for more details. + # # This endpoint can be used to update the `external_plan_id`, and `metadata` of an # existing plan. # @@ -12,8 +15,13 @@ class ExternalPlanID # @overload update(other_external_plan_id, external_plan_id: nil, metadata: nil, request_options: {}) # # @param other_external_plan_id [String] - # @param external_plan_id [String, nil] - # @param metadata [Hash{Symbol=>String, nil}, nil] + # + # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Plan] diff --git a/lib/orb/resources/prices.rb b/lib/orb/resources/prices.rb index 5730fb06..3576701f 100644 --- a/lib/orb/resources/prices.rb +++ b/lib/orb/resources/prices.rb @@ -6,6 +6,9 @@ class Prices # @return [Orb::Resources::Prices::ExternalPriceID] attr_reader :external_price_id + # Some parameter documentations has been truncated, see + # {Orb::Models::PriceCreateParams} for more details. + # # This endpoint is used to create a [price](/product-catalog/price-configuration). # A price created using this endpoint is always an add-on, meaning that it’s not # associated with a specific plan and can instead be individually added to @@ -19,48 +22,96 @@ class Prices # # @overload create(cadence:, currency:, item_id:, model_type:, name:, unit_config:, package_config:, matrix_config:, matrix_with_allocation_config:, tiered_config:, tiered_bps_config:, bps_config:, bulk_bps_config:, bulk_config:, threshold_total_amount_config:, tiered_package_config:, grouped_tiered_config:, max_group_tiered_package_config:, tiered_with_minimum_config:, package_with_allocation_config:, tiered_package_with_minimum_config:, unit_with_percent_config:, tiered_with_proration_config:, unit_with_proration_config:, grouped_allocation_config:, grouped_with_prorated_minimum_config:, grouped_with_metered_minimum_config:, matrix_with_display_name_config:, bulk_with_proration_config:, grouped_tiered_package_config:, scalable_matrix_with_unit_pricing_config:, scalable_matrix_with_tiered_pricing_config:, cumulative_grouped_bulk_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, request_options: {}) # - # @param cadence [Symbol, Orb::Models::PriceCreateParams::Cadence] - # @param currency [String] - # @param item_id [String] + # @param cadence [Symbol, Orb::Models::PriceCreateParams::Cadence] The cadence to bill for this price on. + # + # @param currency [String] An ISO 4217 currency string for which this price is billed in. + # + # @param item_id [String] The id of the item the price will be associated with. + # # @param model_type [Symbol, Orb::Models::PriceCreateParams::ModelType] - # @param name [String] + # + # @param name [String] The name of the price. + # # @param unit_config [Orb::Models::PriceCreateParams::UnitConfig] + # # @param package_config [Orb::Models::PriceCreateParams::PackageConfig] + # # @param matrix_config [Orb::Models::PriceCreateParams::MatrixConfig] + # # @param matrix_with_allocation_config [Orb::Models::PriceCreateParams::MatrixWithAllocationConfig] + # # @param tiered_config [Orb::Models::PriceCreateParams::TieredConfig] + # # @param tiered_bps_config [Orb::Models::PriceCreateParams::TieredBpsConfig] + # # @param bps_config [Orb::Models::PriceCreateParams::BpsConfig] + # # @param bulk_bps_config [Orb::Models::PriceCreateParams::BulkBpsConfig] + # # @param bulk_config [Orb::Models::PriceCreateParams::BulkConfig] + # # @param threshold_total_amount_config [Hash{Symbol=>Object}] + # # @param tiered_package_config [Hash{Symbol=>Object}] + # # @param grouped_tiered_config [Hash{Symbol=>Object}] + # # @param max_group_tiered_package_config [Hash{Symbol=>Object}] + # # @param tiered_with_minimum_config [Hash{Symbol=>Object}] + # # @param package_with_allocation_config [Hash{Symbol=>Object}] + # # @param tiered_package_with_minimum_config [Hash{Symbol=>Object}] + # # @param unit_with_percent_config [Hash{Symbol=>Object}] + # # @param tiered_with_proration_config [Hash{Symbol=>Object}] + # # @param unit_with_proration_config [Hash{Symbol=>Object}] + # # @param grouped_allocation_config [Hash{Symbol=>Object}] + # # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] + # # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] + # # @param matrix_with_display_name_config [Hash{Symbol=>Object}] + # # @param bulk_with_proration_config [Hash{Symbol=>Object}] + # # @param grouped_tiered_package_config [Hash{Symbol=>Object}] + # # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] + # # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] + # # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] - # @param billable_metric_id [String, nil] - # @param billed_in_advance [Boolean, nil] - # @param billing_cycle_configuration [Orb::Models::PriceCreateParams::BillingCycleConfiguration, nil] - # @param conversion_rate [Float, nil] - # @param external_price_id [String, nil] - # @param fixed_price_quantity [Float, nil] - # @param invoice_grouping_key [String, nil] - # @param invoicing_cycle_configuration [Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, nil] - # @param metadata [Hash{Symbol=>String, nil}, nil] + # + # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b + # ... + # + # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi + # ... + # + # @param billing_cycle_configuration [Orb::Models::PriceCreateParams::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont + # ... + # + # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency. + # + # @param external_price_id [String, nil] An alias for the price. + # + # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl + # ... + # + # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice + # + # @param invoicing_cycle_configuration [Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced. + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] @@ -71,6 +122,9 @@ def create(params) @client.request(method: :post, path: "prices", body: parsed, model: Orb::Models::Price, options: options) end + # Some parameter documentations has been truncated, see + # {Orb::Models::PriceUpdateParams} for more details. + # # This endpoint allows you to update the `metadata` property on a price. If you # pass null for the metadata value, it will clear any existing metadata for that # price. @@ -78,7 +132,10 @@ def create(params) # @overload update(price_id, metadata: nil, request_options: {}) # # @param price_id [String] - # @param metadata [Hash{Symbol=>String, nil}, nil] + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] @@ -95,13 +152,19 @@ def update(price_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::PriceListParams} for more details. + # # This endpoint is used to list all add-on prices created using the # [price creation endpoint](/api-reference/price/create-price). # # @overload list(cursor: nil, limit: nil, request_options: {}) # - # @param cursor [String, nil] - # @param limit [Integer] + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] @@ -119,6 +182,9 @@ def list(params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::PriceEvaluateParams} for more details. + # # This endpoint is used to evaluate the output of a price for a given customer and # time range. It enables filtering and grouping the output using # [computed properties](/extensibility/advanced-metrics#computed-properties), @@ -144,12 +210,21 @@ def list(params = {}) # @overload evaluate(price_id, timeframe_end:, timeframe_start:, customer_id: nil, external_customer_id: nil, filter: nil, grouping_keys: nil, request_options: {}) # # @param price_id [String] - # @param timeframe_end [Time] - # @param timeframe_start [Time] - # @param customer_id [String, nil] - # @param external_customer_id [String, nil] - # @param filter [String, nil] - # @param grouping_keys [Array] + # + # @param timeframe_end [Time] The exclusive upper bound for event timestamps + # + # @param timeframe_start [Time] The inclusive lower bound for event timestamps + # + # @param customer_id [String, nil] The ID of the customer to which this evaluation is scoped. + # + # @param external_customer_id [String, nil] The external customer ID of the customer to which this evaluation is scoped. + # + # @param filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie + # ... + # + # @param grouping_keys [Array] Properties (or [computed properties](/extensibility/advanced-metrics#computed-pr + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::PriceEvaluateResponse] diff --git a/lib/orb/resources/prices/external_price_id.rb b/lib/orb/resources/prices/external_price_id.rb index 63e8644b..9e412a51 100644 --- a/lib/orb/resources/prices/external_price_id.rb +++ b/lib/orb/resources/prices/external_price_id.rb @@ -4,6 +4,9 @@ module Orb module Resources class Prices class ExternalPriceID + # Some parameter documentations has been truncated, see + # {Orb::Models::Prices::ExternalPriceIDUpdateParams} for more details. + # # This endpoint allows you to update the `metadata` property on a price. If you # pass null for the metadata value, it will clear any existing metadata for that # price. @@ -11,7 +14,10 @@ class ExternalPriceID # @overload update(external_price_id, metadata: nil, request_options: {}) # # @param external_price_id [String] - # @param metadata [Hash{Symbol=>String, nil}, nil] + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] diff --git a/lib/orb/resources/subscription_changes.rb b/lib/orb/resources/subscription_changes.rb index 27ee80c1..63cd223a 100644 --- a/lib/orb/resources/subscription_changes.rb +++ b/lib/orb/resources/subscription_changes.rb @@ -37,8 +37,11 @@ def retrieve(subscription_change_id, params = {}) # @overload apply(subscription_change_id, description: nil, previously_collected_amount: nil, request_options: {}) # # @param subscription_change_id [String] - # @param description [String, nil] - # @param previously_collected_amount [String, nil] + # + # @param description [String, nil] Description to apply to the balance transaction representing this credit. + # + # @param previously_collected_amount [String, nil] Amount already collected to apply to the customer's balance. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionChangeApplyResponse] diff --git a/lib/orb/resources/subscriptions.rb b/lib/orb/resources/subscriptions.rb index 7eec8163..8373ebbb 100644 --- a/lib/orb/resources/subscriptions.rb +++ b/lib/orb/resources/subscriptions.rb @@ -3,6 +3,9 @@ module Orb module Resources class Subscriptions + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCreateParams} for more details. + # # A subscription represents the purchase of a plan by a customer. The customer is # identified by either the `customer_id` or the `external_customer_id`, and # exactly one of these fields must be provided. @@ -262,37 +265,86 @@ class Subscriptions # # @overload create(add_adjustments: nil, add_prices: nil, align_billing_with_subscription_start_date: nil, auto_collection: nil, aws_region: nil, billing_cycle_anchor_configuration: nil, coupon_redemption_code: nil, credits_overage_rate: nil, customer_id: nil, default_invoice_memo: nil, end_date: nil, external_customer_id: nil, external_marketplace: nil, external_marketplace_reporting_id: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, start_date: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {}) # - # @param add_adjustments [Array, nil] - # @param add_prices [Array, nil] + # @param add_adjustments [Array, nil] Additional adjustments to be added to the subscription. (Only available for acco + # ... + # + # @param add_prices [Array, nil] Additional prices to be added to the subscription. (Only available for accounts + # ... + # # @param align_billing_with_subscription_start_date [Boolean] - # @param auto_collection [Boolean, nil] + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # # @param aws_region [String, nil] + # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionCreateParams::BillingCycleAnchorConfiguration, nil] - # @param coupon_redemption_code [String, nil] + # + # @param coupon_redemption_code [String, nil] Redemption code to be used for this subscription. If the coupon cannot be found + # ... + # # @param credits_overage_rate [Float, nil] + # # @param customer_id [String, nil] - # @param default_invoice_memo [String, nil] + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscription's invoices. Note that if this i + # ... + # # @param end_date [Time, nil] + # # @param external_customer_id [String, nil] + # # @param external_marketplace [Symbol, Orb::Models::SubscriptionCreateParams::ExternalMarketplace, nil] + # # @param external_marketplace_reporting_id [String, nil] - # @param external_plan_id [String, nil] - # @param filter [String, nil] - # @param initial_phase_order [Integer, nil] - # @param invoicing_threshold [String, nil] - # @param metadata [Hash{Symbol=>String, nil}, nil] - # @param net_terms [Integer, nil] + # + # @param external_plan_id [String, nil] The external_plan_id of the plan that the given subscription should be switched + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. This filter must be expressed as + # ... + # + # @param initial_phase_order [Integer, nil] The phase of the plan to start with + # + # @param invoicing_threshold [String, nil] When this subscription's accrued usage reaches this threshold, an invoice will b + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d + # ... + # # @param per_credit_overage_amount [Float, nil] - # @param plan_id [String, nil] - # @param plan_version_number [Integer, nil] - # @param price_overrides [Array, nil] - # @param remove_adjustments [Array, nil] - # @param remove_prices [Array, nil] - # @param replace_adjustments [Array, nil] - # @param replace_prices [Array, nil] + # + # @param plan_id [String, nil] The plan that the given subscription should be switched to. Note that either thi + # ... + # + # @param plan_version_number [Integer, nil] Specifies which version of the plan to subscribe to. If null, the default versio + # ... + # + # @param price_overrides [Array, nil] Optionally provide a list of overrides for prices on the plan + # + # @param remove_adjustments [Array, nil] Plan adjustments to be removed from the subscription. (Only available for accoun + # ... + # + # @param remove_prices [Array, nil] Plan prices to be removed from the subscription. (Only available for accounts th + # ... + # + # @param replace_adjustments [Array, nil] Plan adjustments to be replaced with additional adjustments on the subscription. + # ... + # + # @param replace_prices [Array, nil] Plan prices to be replaced with additional prices on the subscription. (Only ava + # ... + # # @param start_date [Time, nil] - # @param trial_duration_days [Integer, nil] - # @param usage_customer_ids [Array, nil] + # + # @param trial_duration_days [Integer, nil] The duration of the trial period in days. If not provided, this defaults to the + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionCreateResponse] @@ -309,6 +361,9 @@ def create(params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateParams} for more details. + # # This endpoint can be used to update the `metadata`, `net terms`, # `auto_collection`, `invoicing_threshold`, and `default_invoice_memo` properties # on a subscription. @@ -316,11 +371,22 @@ def create(params = {}) # @overload update(subscription_id, auto_collection: nil, default_invoice_memo: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, request_options: {}) # # @param subscription_id [String] - # @param auto_collection [Boolean, nil] - # @param default_invoice_memo [String, nil] - # @param invoicing_threshold [String, nil] - # @param metadata [Hash{Symbol=>String, nil}, nil] - # @param net_terms [Integer, nil] + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscription's invoices. Note that if this i + # ... + # + # @param invoicing_threshold [String, nil] When this subscription's accrued usage reaches this threshold, an invoice will b + # ... + # + # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed + # ... + # + # @param net_terms [Integer, nil] Determines the difference between the invoice issue date for subscription invoic + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Subscription] @@ -337,6 +403,9 @@ def update(subscription_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionListParams} for more details. + # # This endpoint returns a list of all subscriptions for an account as a # [paginated](/api-reference/pagination) list, ordered starting from the most # recently created subscription. For a full discussion of the subscription @@ -350,14 +419,24 @@ def update(subscription_id, params = {}) # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, status: nil, request_options: {}) # # @param created_at_gt [Time, nil] + # # @param created_at_gte [Time, nil] + # # @param created_at_lt [Time, nil] + # # @param created_at_lte [Time, nil] - # @param cursor [String, nil] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # # @param customer_id [Array, nil] + # # @param external_customer_id [Array, nil] - # @param limit [Integer] + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param status [Symbol, Orb::Models::SubscriptionListParams::Status, nil] + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] @@ -380,6 +459,9 @@ def list(params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionCancelParams} for more details. + # # This endpoint can be used to cancel an existing subscription. It returns the # serialized subscription object with an `end_date` parameter that signifies when # the subscription will transition to an ended state. @@ -445,9 +527,15 @@ def list(params = {}) # @overload cancel(subscription_id, cancel_option:, allow_invoice_credit_or_void: nil, cancellation_date: nil, request_options: {}) # # @param subscription_id [String] - # @param cancel_option [Symbol, Orb::Models::SubscriptionCancelParams::CancelOption] - # @param allow_invoice_credit_or_void [Boolean, nil] - # @param cancellation_date [Time, nil] + # + # @param cancel_option [Symbol, Orb::Models::SubscriptionCancelParams::CancelOption] Determines the timing of subscription cancellation + # + # @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a + # ... + # + # @param cancellation_date [Time, nil] The date that the cancellation should take effect. This parameter can only be pa + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionCancelResponse] @@ -484,6 +572,9 @@ def fetch(subscription_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionFetchCostsParams} for more details. + # # This endpoint is used to fetch a day-by-day snapshot of a subscription's costs # in Orb, calculated by applying pricing information to the underlying usage (see # the [subscription usage endpoint](fetch-subscription-usage) to fetch usage per @@ -498,10 +589,16 @@ def fetch(subscription_id, params = {}) # @overload fetch_costs(subscription_id, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) # # @param subscription_id [String] - # @param currency [String, nil] - # @param timeframe_end [Time, nil] - # @param timeframe_start [Time, nil] - # @param view_mode [Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode, nil] + # + # @param currency [String, nil] The currency or custom pricing unit to use. + # + # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`. + # + # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`. + # + # @param view_mode [Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionFetchCostsResponse] @@ -518,6 +615,9 @@ def fetch_costs(subscription_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionFetchScheduleParams} for more details. + # # This endpoint returns a [paginated](/api-reference/pagination) list of all plans # associated with a subscription along with their start and end dates. This list # contains the subscription's initial plan along with past and future plan @@ -526,12 +626,20 @@ def fetch_costs(subscription_id, params = {}) # @overload fetch_schedule(subscription_id, cursor: nil, limit: nil, start_date_gt: nil, start_date_gte: nil, start_date_lt: nil, start_date_lte: nil, request_options: {}) # # @param subscription_id [String] - # @param cursor [String, nil] - # @param limit [Integer] + # + # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned + # ... + # + # @param limit [Integer] The number of items to fetch. Defaults to 20. + # # @param start_date_gt [Time, nil] + # # @param start_date_gte [Time, nil] + # # @param start_date_lt [Time, nil] + # # @param start_date_lte [Time, nil] + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Internal::Page] @@ -554,6 +662,9 @@ def fetch_schedule(subscription_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionFetchUsageParams} for more details. + # # This endpoint is used to fetch a subscription's usage in Orb. Especially when # combined with optional query parameters, this endpoint is a powerful way to # build visualizations on top of Orb's event data and metrics. @@ -752,16 +863,29 @@ def fetch_schedule(subscription_id, params = {}) # @overload fetch_usage(subscription_id, billable_metric_id: nil, first_dimension_key: nil, first_dimension_value: nil, granularity: nil, group_by: nil, second_dimension_key: nil, second_dimension_value: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) # # @param subscription_id [String] - # @param billable_metric_id [String, nil] + # + # @param billable_metric_id [String, nil] When specified in conjunction with `group_by`, this parameter filters usage to a + # ... + # # @param first_dimension_key [String, nil] + # # @param first_dimension_value [String, nil] - # @param granularity [Symbol, Orb::Models::SubscriptionFetchUsageParams::Granularity, nil] - # @param group_by [String, nil] + # + # @param granularity [Symbol, Orb::Models::SubscriptionFetchUsageParams::Granularity, nil] This determines the windowing of usage reporting. + # + # @param group_by [String, nil] Groups per-price usage by the key provided. + # # @param second_dimension_key [String, nil] + # # @param second_dimension_value [String, nil] - # @param timeframe_end [Time, nil] - # @param timeframe_start [Time, nil] - # @param view_mode [Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode, nil] + # + # @param timeframe_end [Time, nil] Usage returned is exclusive of `timeframe_end`. + # + # @param timeframe_start [Time, nil] Usage returned is inclusive of `timeframe_start`. + # + # @param view_mode [Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode, nil] Controls whether Orb returns cumulative usage since the start of the billing per + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage] @@ -778,6 +902,9 @@ def fetch_usage(subscription_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionPriceIntervalsParams} for more details. + # # This endpoint is used to add and edit subscription # [price intervals](/api-reference/price-interval/add-or-edit-price-intervals). By # making modifications to a subscription’s price intervals, you can @@ -854,11 +981,18 @@ def fetch_usage(subscription_id, params = {}) # @overload price_intervals(subscription_id, add: nil, add_adjustments: nil, allow_invoice_credit_or_void: nil, edit: nil, edit_adjustments: nil, request_options: {}) # # @param subscription_id [String] - # @param add [Array] - # @param add_adjustments [Array] - # @param allow_invoice_credit_or_void [Boolean, nil] - # @param edit [Array] - # @param edit_adjustments [Array] + # + # @param add [Array] A list of price intervals to add to the subscription. + # + # @param add_adjustments [Array] A list of adjustments to add to the subscription. + # + # @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a + # ... + # + # @param edit [Array] A list of price intervals to edit on the subscription. + # + # @param edit_adjustments [Array] A list of adjustments to edit on the subscription. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionPriceIntervalsResponse] @@ -875,6 +1009,9 @@ def price_intervals(subscription_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionSchedulePlanChangeParams} for more details. + # # This endpoint can be used to change an existing subscription's plan. It returns # the serialized updated subscription object. # @@ -1062,32 +1199,79 @@ def price_intervals(subscription_id, params = {}) # @overload schedule_plan_change(subscription_id, change_option:, add_adjustments: nil, add_prices: nil, align_billing_with_plan_change_date: nil, auto_collection: nil, billing_cycle_alignment: nil, billing_cycle_anchor_configuration: nil, change_date: nil, coupon_redemption_code: nil, credits_overage_rate: nil, default_invoice_memo: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {}) # # @param subscription_id [String] + # # @param change_option [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption] - # @param add_adjustments [Array, nil] - # @param add_prices [Array, nil] - # @param align_billing_with_plan_change_date [Boolean, nil] - # @param auto_collection [Boolean, nil] - # @param billing_cycle_alignment [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment, nil] + # + # @param add_adjustments [Array, nil] Additional adjustments to be added to the subscription. (Only available for acco + # ... + # + # @param add_prices [Array, nil] Additional prices to be added to the subscription. (Only available for accounts + # ... + # + # @param align_billing_with_plan_change_date [Boolean, nil] [DEPRECATED] Use billing_cycle_alignment instead. Reset billing periods to be al + # ... + # + # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c + # ... + # + # @param billing_cycle_alignment [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment, nil] Reset billing periods to be aligned with the plan change's effective date or sta + # ... + # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAnchorConfiguration, nil] - # @param change_date [Time, nil] - # @param coupon_redemption_code [String, nil] + # + # @param change_date [Time, nil] The date that the plan change should take effect. This parameter can only be pas + # ... + # + # @param coupon_redemption_code [String, nil] Redemption code to be used for this subscription. If the coupon cannot be found + # ... + # # @param credits_overage_rate [Float, nil] - # @param default_invoice_memo [String, nil] - # @param external_plan_id [String, nil] - # @param filter [String, nil] - # @param initial_phase_order [Integer, nil] - # @param invoicing_threshold [String, nil] - # @param net_terms [Integer, nil] + # + # @param default_invoice_memo [String, nil] Determines the default memo on this subscription's invoices. Note that if this i + # ... + # + # @param external_plan_id [String, nil] The external_plan_id of the plan that the given subscription should be switched + # ... + # + # @param filter [String, nil] An additional filter to apply to usage queries. This filter must be expressed as + # ... + # + # @param initial_phase_order [Integer, nil] The phase of the plan to start with + # + # @param invoicing_threshold [String, nil] When this subscription's accrued usage reaches this threshold, an invoice will b + # ... + # + # @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d + # ... + # # @param per_credit_overage_amount [Float, nil] - # @param plan_id [String, nil] - # @param plan_version_number [Integer, nil] - # @param price_overrides [Array, nil] - # @param remove_adjustments [Array, nil] - # @param remove_prices [Array, nil] - # @param replace_adjustments [Array, nil] - # @param replace_prices [Array, nil] - # @param trial_duration_days [Integer, nil] - # @param usage_customer_ids [Array, nil] + # + # @param plan_id [String, nil] The plan that the given subscription should be switched to. Note that either thi + # ... + # + # @param plan_version_number [Integer, nil] Specifies which version of the plan to change to. If null, the default version w + # ... + # + # @param price_overrides [Array, nil] Optionally provide a list of overrides for prices on the plan + # + # @param remove_adjustments [Array, nil] Plan adjustments to be removed from the subscription. (Only available for accoun + # ... + # + # @param remove_prices [Array, nil] Plan prices to be removed from the subscription. (Only available for accounts th + # ... + # + # @param replace_adjustments [Array, nil] Plan adjustments to be replaced with additional adjustments on the subscription. + # ... + # + # @param replace_prices [Array, nil] Plan prices to be replaced with additional prices on the subscription. (Only ava + # ... + # + # @param trial_duration_days [Integer, nil] The duration of the trial period in days. If not provided, this defaults to the + # ... + # + # @param usage_customer_ids [Array, nil] A list of customer IDs whose usage events will be aggregated and billed under th + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionSchedulePlanChangeResponse] @@ -1104,14 +1288,22 @@ def schedule_plan_change(subscription_id, params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionTriggerPhaseParams} for more details. + # # Manually trigger a phase, effective the given date (or the current time, if not # specified). # # @overload trigger_phase(subscription_id, allow_invoice_credit_or_void: nil, effective_date: nil, request_options: {}) # # @param subscription_id [String] - # @param allow_invoice_credit_or_void [Boolean, nil] - # @param effective_date [Date, nil] + # + # @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a + # ... + # + # @param effective_date [Date, nil] The date on which the phase change should take effect. If not provided, defaults + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionTriggerPhaseResponse] @@ -1161,7 +1353,9 @@ def unschedule_cancellation(subscription_id, params = {}) # @overload unschedule_fixed_fee_quantity_updates(subscription_id, price_id:, request_options: {}) # # @param subscription_id [String] - # @param price_id [String] + # + # @param price_id [String] Price for which the updates should be cleared. Must be a fixed fee. + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse] @@ -1198,6 +1392,9 @@ def unschedule_pending_plan_changes(subscription_id, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateFixedFeeQuantityParams} for more details. + # # This endpoint can be used to update the quantity for a fixed fee. # # To be eligible, the subscription must currently be active and the price @@ -1216,11 +1413,20 @@ def unschedule_pending_plan_changes(subscription_id, params = {}) # @overload update_fixed_fee_quantity(subscription_id, price_id:, quantity:, allow_invoice_credit_or_void: nil, change_option: nil, effective_date: nil, request_options: {}) # # @param subscription_id [String] - # @param price_id [String] + # + # @param price_id [String] Price for which the quantity should be updated. Must be a fixed fee. + # # @param quantity [Float] - # @param allow_invoice_credit_or_void [Boolean, nil] - # @param change_option [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption] - # @param effective_date [Date, nil] + # + # @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a + # ... + # + # @param change_option [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption] Determines when the change takes effect. Note that if `effective_date` is specif + # ... + # + # @param effective_date [Date, nil] The date that the quantity change should take effect, localized to the customer' + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse] @@ -1237,6 +1443,9 @@ def update_fixed_fee_quantity(subscription_id, params) ) end + # Some parameter documentations has been truncated, see + # {Orb::Models::SubscriptionUpdateTrialParams} for more details. + # # This endpoint is used to update the trial end date for a subscription. The new # trial end date must be within the time range of the current plan (i.e. the new # trial end date must be on or after the subscription's start date on the current @@ -1259,8 +1468,13 @@ def update_fixed_fee_quantity(subscription_id, params) # @overload update_trial(subscription_id, trial_end_date:, shift: nil, request_options: {}) # # @param subscription_id [String] - # @param trial_end_date [Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate] - # @param shift [Boolean] + # + # @param trial_end_date [Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate] The new date that the trial should end, or the literal string `immediate` to end + # ... + # + # @param shift [Boolean] If true, shifts subsequent price and adjustment intervals (preserving their dura + # ... + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionUpdateTrialResponse] diff --git a/lib/orb/version.rb b/lib/orb/version.rb index 4fa2a003..6e325567 100644 --- a/lib/orb/version.rb +++ b/lib/orb/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Orb - VERSION = "0.2.0" + VERSION = "0.3.0" end diff --git a/rbi/lib/orb/client.rbi b/rbi/lib/orb/client.rbi index f3b58afe..60cade2c 100644 --- a/rbi/lib/orb/client.rbi +++ b/rbi/lib/orb/client.rbi @@ -82,10 +82,10 @@ module Orb # `"https://api.example.com/v2/"`. Defaults to `ENV["ORB_BASE_URL"]` base_url: ENV["ORB_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: Orb::Client::DEFAULT_MAX_RETRIES, + timeout: Orb::Client::DEFAULT_TIMEOUT_IN_SECONDS, + initial_retry_delay: Orb::Client::DEFAULT_INITIAL_RETRY_DELAY, + max_retry_delay: Orb::Client::DEFAULT_MAX_RETRY_DELAY, idempotency_header: "Idempotency-Key" ); end end diff --git a/rbi/lib/orb/file_part.rbi b/rbi/lib/orb/file_part.rbi new file mode 100644 index 00000000..fe868cc5 --- /dev/null +++ b/rbi/lib/orb/file_part.rbi @@ -0,0 +1,34 @@ +# typed: strong + +module Orb + class FilePart + sig { returns(T.any(Pathname, StringIO, IO, String)) } + attr_reader :content + + sig { returns(T.nilable(String)) } + attr_reader :content_type + + sig { returns(T.nilable(String)) } + attr_reader :filename + + # @api private + sig { returns(String) } + private def read; end + + sig { params(a: T.anything).returns(String) } + def to_json(*a); end + + sig { params(a: T.anything).returns(String) } + def to_yaml(*a); end + + sig do + params( + content: T.any(Pathname, StringIO, IO, String), + filename: T.nilable(String), + content_type: T.nilable(String) + ) + .returns(T.attached_class) + end + def self.new(content, filename: nil, content_type: nil); end + end +end diff --git a/rbi/lib/orb/internal.rbi b/rbi/lib/orb/internal.rbi index 02b59bf4..f702fce7 100644 --- a/rbi/lib/orb/internal.rbi +++ b/rbi/lib/orb/internal.rbi @@ -1,7 +1,6 @@ # typed: strong module Orb - # @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/orb/internal/transport/base_client.rbi b/rbi/lib/orb/internal/transport/base_client.rbi index 3b8a885b..d26248e6 100644 --- a/rbi/lib/orb/internal/transport/base_client.rbi +++ b/rbi/lib/orb/internal/transport/base_client.rbi @@ -24,7 +24,14 @@ module Orb )] ), body: T.nilable(T.anything), - unwrap: T.nilable(Symbol), + unwrap: T.nilable( + T.any( + Symbol, + Integer, + T::Array[T.any(Symbol, Integer)], + T.proc.params(arg0: T.anything).returns(T.anything) + ) + ), page: T.nilable(T::Class[Orb::Internal::Type::BasePage[Orb::Internal::Type::BaseModel]]), stream: T.nilable(T::Class[T.anything]), model: T.nilable(Orb::Internal::Type::Converter::Input), @@ -90,7 +97,7 @@ module Orb # @api private sig { returns(Orb::Internal::Transport::PooledNetRequester) } - attr_accessor :requester + attr_reader :requester # @api private sig do @@ -167,7 +174,14 @@ module Orb )] ), body: T.nilable(T.anything), - unwrap: T.nilable(Symbol), + unwrap: T.nilable( + T.any( + Symbol, + Integer, + T::Array[T.any(Symbol, Integer)], + T.proc.params(arg0: T.anything).returns(T.anything) + ) + ), page: T.nilable(T::Class[Orb::Internal::Type::BasePage[Orb::Internal::Type::BaseModel]]), stream: T.nilable(T::Class[T.anything]), model: T.nilable(Orb::Internal::Type::Converter::Input), diff --git a/rbi/lib/orb/internal/type/array_of.rbi b/rbi/lib/orb/internal/type/array_of.rbi index 1f8fd4a7..657737ea 100644 --- a/rbi/lib/orb/internal/type/array_of.rbi +++ b/rbi/lib/orb/internal/type/array_of.rbi @@ -32,6 +32,9 @@ module Orb 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/orb/internal/type/base_model.rbi b/rbi/lib/orb/internal/type/base_model.rbi index fadb4e30..aa7eb23a 100644 --- a/rbi/lib/orb/internal/type/base_model.rbi +++ b/rbi/lib/orb/internal/type/base_model.rbi @@ -111,11 +111,17 @@ module Orb 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 @@ -176,6 +182,7 @@ module Orb def deconstruct_keys(keys); end class << self + # @api private sig { params(model: Orb::Internal::Type::BaseModel).returns(Orb::Internal::AnyHash) } def walk(model); end end @@ -196,7 +203,6 @@ module Orb def inspect(depth: 0); end end - # @api private sig { returns(String) } def to_s; end diff --git a/rbi/lib/orb/internal/type/base_page.rbi b/rbi/lib/orb/internal/type/base_page.rbi index e6009a6b..0face544 100644 --- a/rbi/lib/orb/internal/type/base_page.rbi +++ b/rbi/lib/orb/internal/type/base_page.rbi @@ -3,6 +3,8 @@ module Orb 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/orb/internal/type/enum.rbi b/rbi/lib/orb/internal/type/enum.rbi index 6eb41366..683f32cc 100644 --- a/rbi/lib/orb/internal/type/enum.rbi +++ b/rbi/lib/orb/internal/type/enum.rbi @@ -22,18 +22,15 @@ module Orb 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/orb/internal/type/io_like.rbi b/rbi/lib/orb/internal/type/file_input.rbi similarity index 83% rename from rbi/lib/orb/internal/type/io_like.rbi rename to rbi/lib/orb/internal/type/file_input.rbi index 47798fbe..d19954b1 100644 --- a/rbi/lib/orb/internal/type/io_like.rbi +++ b/rbi/lib/orb/internal/type/file_input.rbi @@ -5,8 +5,11 @@ module Orb module Type # @api private # - # Either `Pathname` or `StringIO`. - class IOLike + # Either `Pathname` or `StringIO`, or `IO`, or `Orb::Internal::Type::FileInput`. + # + # Note: when `IO` is used, all retries are disabled, since many IO` streams are + # not rewindable. + class FileInput extend Orb::Internal::Type::Converter abstract! diff --git a/rbi/lib/orb/internal/type/hash_of.rbi b/rbi/lib/orb/internal/type/hash_of.rbi index 8072f046..9041321f 100644 --- a/rbi/lib/orb/internal/type/hash_of.rbi +++ b/rbi/lib/orb/internal/type/hash_of.rbi @@ -32,6 +32,9 @@ module Orb 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/orb/internal/type/union.rbi b/rbi/lib/orb/internal/type/union.rbi index 2675dc8b..65ece27c 100644 --- a/rbi/lib/orb/internal/type/union.rbi +++ b/rbi/lib/orb/internal/type/union.rbi @@ -45,6 +45,9 @@ module Orb sig { params(other: T.anything).returns(T::Boolean) } def ==(other); end + sig { returns(Integer) } + def hash; end + # @api private sig do override.params( diff --git a/rbi/lib/orb/internal/util.rbi b/rbi/lib/orb/internal/util.rbi index a8284783..20c33920 100644 --- a/rbi/lib/orb/internal/util.rbi +++ b/rbi/lib/orb/internal/util.rbi @@ -68,13 +68,19 @@ module Orb sig do params( data: T.any(Orb::Internal::AnyHash, T::Array[T.anything], T.anything), - pick: T.nilable(T.any(Symbol, Integer, T::Array[T.any(Symbol, Integer)])), - sentinel: T.nilable(T.anything), + pick: T.nilable( + T.any( + Symbol, + Integer, + T::Array[T.any(Symbol, Integer)], + T.proc.params(arg0: T.anything).returns(T.anything) + ) + ), blk: T.nilable(T.proc.returns(T.anything)) ) .returns(T.nilable(T.anything)) end - def dig(data, pick, sentinel = nil, &blk); end + def dig(data, pick, &blk); end end class << self @@ -140,22 +146,6 @@ module Orb def normalized_headers(*headers); end end - # @api private - class SerializationAdapter - sig { returns(T.any(Pathname, IO)) } - attr_reader :inner - - sig { params(a: T.anything).returns(String) } - def to_json(*a); end - - sig { params(a: T.anything).returns(String) } - def to_yaml(*a); end - - # @api private - sig { params(inner: T.any(Pathname, IO)).returns(T.attached_class) } - def self.new(inner); end - end - # @api private # # An adapter that satisfies the IO interface required by `::IO.copy_stream` @@ -192,7 +182,22 @@ module Orb def writable_enum(&blk); end end + JSON_CONTENT = T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp) + JSONL_CONTENT = T.let(%r{^application/(?:x-)?jsonl}, Regexp) + class << self + # @api private + sig do + params( + y: Enumerator::Yielder, + val: T.anything, + closing: T::Array[T.proc.void], + content_type: T.nilable(String) + ) + .void + end + private def write_multipart_content(y, val:, closing:, content_type: nil); end + # @api private sig do params( diff --git a/rbi/lib/orb/models/alert.rbi b/rbi/lib/orb/models/alert.rbi index 6acb0ac1..6a4a0ad8 100644 --- a/rbi/lib/orb/models/alert.rbi +++ b/rbi/lib/orb/models/alert.rbi @@ -77,19 +77,28 @@ module Orb .returns(T.attached_class) end def self.new( + # Also referred to as alert_id in this documentation. id:, + # The creation time of the resource in Orb. created_at:, + # The name of the currency the credit balance or invoice cost is denominated in. currency:, + # The customer the alert applies to. customer:, + # Whether the alert is enabled or disabled. enabled:, + # The metric the alert applies to. metric:, + # The plan the alert applies to. plan:, + # The subscription the alert applies to. subscription:, + # The thresholds that define the conditions under which the alert will be + # triggered. thresholds:, + # The type of alert. This must be a valid alert type. type: - ) - end - + ); end sig do override .returns( @@ -162,8 +171,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, external_plan_id:, name:, plan_version:); end - + def self.new( + id:, + # An optional user-defined ID for this plan resource, used throughout the system + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. + external_plan_id:, + name:, + plan_version: + ); end sig do override .returns( @@ -200,8 +216,12 @@ module Orb # Thresholds are used to define the conditions under which an alert will be # triggered. sig { params(value: Float).returns(T.attached_class) } - def self.new(value:); end - + def self.new( + # The value at which an alert will fire. For credit balance alerts, the alert will + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. + value: + ); end sig { override.returns({value: Float}) } def to_hash; end end @@ -211,7 +231,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Alert::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Alert::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CREDIT_BALANCE_DEPLETED = T.let(:credit_balance_depleted, Orb::Models::Alert::Type::TaggedSymbol) CREDIT_BALANCE_DROPPED = T.let(:credit_balance_dropped, Orb::Models::Alert::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/alert_create_for_customer_params.rbi b/rbi/lib/orb/models/alert_create_for_customer_params.rbi index 1a02de4b..aa928c2b 100644 --- a/rbi/lib/orb/models/alert_create_for_customer_params.rbi +++ b/rbi/lib/orb/models/alert_create_for_customer_params.rbi @@ -27,8 +27,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(currency:, type:, thresholds: nil, request_options: {}); end - + def self.new( + # The case sensitive currency or custom pricing unit to use for this alert. + currency:, + # The type of alert to create. This must be a valid alert type. + type:, + # The thresholds that define the values at which the alert will be triggered. + thresholds: nil, + request_options: {} + ); end sig do override .returns( @@ -47,8 +54,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AlertCreateForCustomerParams::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CREDIT_BALANCE_DEPLETED = T.let(:credit_balance_depleted, Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol) @@ -71,8 +77,12 @@ module Orb # Thresholds are used to define the conditions under which an alert will be # triggered. sig { params(value: Float).returns(T.attached_class) } - def self.new(value:); end - + def self.new( + # The value at which an alert will fire. For credit balance alerts, the alert will + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. + value: + ); end sig { override.returns({value: Float}) } def to_hash; end end diff --git a/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi b/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi index cc729aa2..d063e7b3 100644 --- a/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +++ b/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi @@ -29,8 +29,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(currency:, type:, thresholds: nil, request_options: {}); end - + def self.new( + # The case sensitive currency or custom pricing unit to use for this alert. + currency:, + # The type of alert to create. This must be a valid alert type. + type:, + # The thresholds that define the values at which the alert will be triggered. + thresholds: nil, + request_options: {} + ); end sig do override .returns( @@ -49,8 +56,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CREDIT_BALANCE_DEPLETED = T.let(:credit_balance_depleted, Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol) @@ -73,8 +79,12 @@ module Orb # Thresholds are used to define the conditions under which an alert will be # triggered. sig { params(value: Float).returns(T.attached_class) } - def self.new(value:); end - + def self.new( + # The value at which an alert will fire. For credit balance alerts, the alert will + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. + value: + ); end sig { override.returns({value: Float}) } def to_hash; end end diff --git a/rbi/lib/orb/models/alert_create_for_subscription_params.rbi b/rbi/lib/orb/models/alert_create_for_subscription_params.rbi index 6e44c043..d79e3282 100644 --- a/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +++ b/rbi/lib/orb/models/alert_create_for_subscription_params.rbi @@ -27,8 +27,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(thresholds:, type:, metric_id: nil, request_options: {}); end - + def self.new( + # The thresholds that define the values at which the alert will be triggered. + thresholds:, + # The type of alert to create. This must be a valid alert type. + type:, + # The metric to track usage for. + metric_id: nil, + request_options: {} + ); end sig do override .returns( @@ -52,8 +59,12 @@ module Orb # Thresholds are used to define the conditions under which an alert will be # triggered. sig { params(value: Float).returns(T.attached_class) } - def self.new(value:); end - + def self.new( + # The value at which an alert will fire. For credit balance alerts, the alert will + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. + value: + ); end sig { override.returns({value: Float}) } def to_hash; end end @@ -63,8 +74,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::AlertCreateForSubscriptionParams::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_EXCEEDED = T.let(:usage_exceeded, Orb::Models::AlertCreateForSubscriptionParams::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/alert_disable_params.rbi b/rbi/lib/orb/models/alert_disable_params.rbi index c1c89785..63aa0c39 100644 --- a/rbi/lib/orb/models/alert_disable_params.rbi +++ b/rbi/lib/orb/models/alert_disable_params.rbi @@ -17,8 +17,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(subscription_id: nil, request_options: {}); end - + def self.new( + # Used to update the status of a plan alert scoped to this subscription_id + subscription_id: nil, + request_options: {} + ); end sig { override.returns({subscription_id: T.nilable(String), request_options: Orb::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/orb/models/alert_enable_params.rbi b/rbi/lib/orb/models/alert_enable_params.rbi index ba207aa7..03312c73 100644 --- a/rbi/lib/orb/models/alert_enable_params.rbi +++ b/rbi/lib/orb/models/alert_enable_params.rbi @@ -17,8 +17,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(subscription_id: nil, request_options: {}); end - + def self.new( + # Used to update the status of a plan alert scoped to this subscription_id + subscription_id: nil, + request_options: {} + ); end sig { override.returns({subscription_id: T.nilable(String), request_options: Orb::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/orb/models/alert_list_params.rbi b/rbi/lib/orb/models/alert_list_params.rbi index 38f8759b..d4db90f0 100644 --- a/rbi/lib/orb/models/alert_list_params.rbi +++ b/rbi/lib/orb/models/alert_list_params.rbi @@ -62,10 +62,16 @@ module Orb created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. cursor: nil, + # Fetch alerts scoped to this customer_id customer_id: nil, + # Fetch alerts scoped to this external_customer_id external_customer_id: nil, + # The number of items to fetch. Defaults to 20. limit: nil, + # Fetch alerts scoped to this subscription_id subscription_id: nil, request_options: {} ); end diff --git a/rbi/lib/orb/models/alert_update_params.rbi b/rbi/lib/orb/models/alert_update_params.rbi index 9c10493b..7e654cba 100644 --- a/rbi/lib/orb/models/alert_update_params.rbi +++ b/rbi/lib/orb/models/alert_update_params.rbi @@ -17,8 +17,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(thresholds:, request_options: {}); end - + def self.new( + # The thresholds that define the values at which the alert will be triggered. + thresholds:, + request_options: {} + ); end sig do override .returns( @@ -37,8 +40,12 @@ module Orb # Thresholds are used to define the conditions under which an alert will be # triggered. sig { params(value: Float).returns(T.attached_class) } - def self.new(value:); end - + def self.new( + # The value at which an alert will fire. For credit balance alerts, the alert will + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. + value: + ); end sig { override.returns({value: Float}) } def to_hash; end end diff --git a/rbi/lib/orb/models/amount_discount.rbi b/rbi/lib/orb/models/amount_discount.rbi index a5ca1de8..9c7defc4 100644 --- a/rbi/lib/orb/models/amount_discount.rbi +++ b/rbi/lib/orb/models/amount_discount.rbi @@ -27,8 +27,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount_discount:, applies_to_price_ids:, discount_type:, reason: nil); end - + def self.new( + # Only available if discount_type is `amount`. + amount_discount:, + # List of price_ids that this discount applies to. For plan/plan phase discounts, + # this can be a subset of prices. + applies_to_price_ids:, + discount_type:, + reason: nil + ); end sig do override .returns( @@ -46,8 +53,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AmountDiscount::DiscountType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::AmountDiscount::DiscountType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } AMOUNT = T.let(:amount, Orb::Models::AmountDiscount::DiscountType::TaggedSymbol) diff --git a/rbi/lib/orb/models/billable_metric.rbi b/rbi/lib/orb/models/billable_metric.rbi index 4616af64..4d42c965 100644 --- a/rbi/lib/orb/models/billable_metric.rbi +++ b/rbi/lib/orb/models/billable_metric.rbi @@ -45,8 +45,21 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, description:, item:, metadata:, name:, status:); end - + def self.new( + id:, + description:, + # The Item resource represents a sellable product or good. Items are associated + # with all line items, billable metrics, and prices and are used for defining + # external sync behavior for invoices and tax calculation purposes. + item:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. + metadata:, + name:, + status: + ); end sig do override .returns( @@ -66,7 +79,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::BillableMetric::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::BillableMetric::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::BillableMetric::Status::TaggedSymbol) DRAFT = T.let(:draft, Orb::Models::BillableMetric::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/billing_cycle_relative_date.rbi b/rbi/lib/orb/models/billing_cycle_relative_date.rbi index c5b19cb3..e37a62da 100644 --- a/rbi/lib/orb/models/billing_cycle_relative_date.rbi +++ b/rbi/lib/orb/models/billing_cycle_relative_date.rbi @@ -6,7 +6,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::BillingCycleRelativeDate) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::BillingCycleRelativeDate::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } START_OF_TERM = T.let(:start_of_term, Orb::Models::BillingCycleRelativeDate::TaggedSymbol) END_OF_TERM = T.let(:end_of_term, Orb::Models::BillingCycleRelativeDate::TaggedSymbol) diff --git a/rbi/lib/orb/models/coupon.rbi b/rbi/lib/orb/models/coupon.rbi index 3e0a1644..91ad8f76 100644 --- a/rbi/lib/orb/models/coupon.rbi +++ b/rbi/lib/orb/models/coupon.rbi @@ -51,16 +51,23 @@ module Orb .returns(T.attached_class) end def self.new( + # Also referred to as coupon_id in this documentation. id:, + # An archived coupon can no longer be redeemed. Active coupons will have a value + # of null for `archived_at`; this field will be non-null for archived coupons. archived_at:, discount:, + # This allows for a coupon's discount to apply for a limited time (determined in + # months); a `null` value here means "unlimited time". duration_in_months:, + # The maximum number of redemptions allowed for this coupon before it is + # exhausted; `null` here means "unlimited". max_redemptions:, + # This string can be used to redeem this coupon for a given subscription. redemption_code:, + # The number of times this coupon has been redeemed. times_redeemed: - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/coupon_create_params.rbi b/rbi/lib/orb/models/coupon_create_params.rbi index e561b3c8..9c209c86 100644 --- a/rbi/lib/orb/models/coupon_create_params.rbi +++ b/rbi/lib/orb/models/coupon_create_params.rbi @@ -46,13 +46,16 @@ module Orb end def self.new( discount:, + # This string can be used to redeem this coupon for a given subscription. redemption_code:, + # This allows for a coupon's discount to apply for a limited time (determined in + # months); a `null` value here means "unlimited time". duration_in_months: nil, + # The maximum number of redemptions allowed for this coupon before it is + # exhausted;`null` here means "unlimited". max_redemptions: nil, request_options: {} - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/coupon_list_params.rbi b/rbi/lib/orb/models/coupon_list_params.rbi index d323ee34..c79e26a6 100644 --- a/rbi/lib/orb/models/coupon_list_params.rbi +++ b/rbi/lib/orb/models/coupon_list_params.rbi @@ -37,9 +37,19 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {}) - end - + def self.new( + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. + cursor: nil, + # The number of items to fetch. Defaults to 20. + limit: nil, + # Filter to coupons matching this redemption code. + redemption_code: nil, + # Show archived coupons as well (by default, this endpoint only returns active + # coupons). + show_archived: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/coupons/subscription_list_params.rbi b/rbi/lib/orb/models/coupons/subscription_list_params.rbi index cccbc4ac..52da968a 100644 --- a/rbi/lib/orb/models/coupons/subscription_list_params.rbi +++ b/rbi/lib/orb/models/coupons/subscription_list_params.rbi @@ -27,8 +27,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}); end - + def self.new( + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. + cursor: nil, + # The number of items to fetch. Defaults to 20. + limit: nil, + request_options: {} + ); end sig do override.returns({cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOptions}) end diff --git a/rbi/lib/orb/models/credit_note.rbi b/rbi/lib/orb/models/credit_note.rbi index 1ba9b6ee..10925ab7 100644 --- a/rbi/lib/orb/models/credit_note.rbi +++ b/rbi/lib/orb/models/credit_note.rbi @@ -102,21 +102,34 @@ module Orb .returns(T.attached_class) end def self.new( + # The Orb id of this credit note. id:, + # The creation time of the resource in Orb. created_at:, + # The unique identifier for credit notes. credit_note_number:, + # A URL to a PDF of the credit note. credit_note_pdf:, customer:, + # The id of the invoice resource that this credit note is applied to. invoice_id:, + # All of the line items associated with this credit note. line_items:, + # The maximum amount applied on the original invoice maximum_amount_adjustment:, + # An optional memo supplied on the credit note. memo:, + # Any credited amount from the applied minimum on the invoice. minimum_amount_refunded:, reason:, + # The total prior to any creditable invoice-level discounts or minimums. subtotal:, + # The total including creditable invoice-level discounts or minimums, and tax. total:, type:, + # The time at which the credit note was voided in Orb, if applicable. voided_at:, + # Any discounts applied on the original invoice. discounts: nil ); end sig do @@ -210,8 +223,24 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil); end - + def self.new( + # The Orb id of this resource. + id:, + # The amount of the line item, including any line item minimums and discounts. + amount:, + # The id of the item associated with this line item. + item_id:, + # The name of the corresponding invoice line item. + name:, + # An optional quantity credited. + quantity:, + # The amount of the line item, excluding any line item minimums and discounts. + subtotal:, + # Any tax amounts applied onto the line item. + tax_amounts:, + # Any line item discounts from the invoice's line item. + discounts: nil + ); end sig do override .returns( @@ -246,8 +275,14 @@ module Orb params(amount: String, tax_rate_description: String, tax_rate_percentage: T.nilable(String)) .returns(T.attached_class) end - def self.new(amount:, tax_rate_description:, tax_rate_percentage:); end - + def self.new( + # The amount of additional tax incurred by this tax rate. + amount:, + # The human-readable description of the applied tax rate. + tax_rate_description:, + # The tax rate percentage, out of 100. + tax_rate_percentage: + ); end sig do override.returns( { @@ -323,8 +358,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PERCENTAGE = T.let(:percentage, Orb::Models::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol) AMOUNT = T.let(:amount, Orb::Models::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol) @@ -392,8 +426,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PERCENTAGE = T.let(:percentage, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType::TaggedSymbol) @@ -421,7 +454,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNote::Reason) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } DUPLICATE = T.let(:Duplicate, Orb::Models::CreditNote::Reason::TaggedSymbol) FRAUDULENT = T.let(:Fraudulent, Orb::Models::CreditNote::Reason::TaggedSymbol) @@ -436,7 +469,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNote::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } REFUND = T.let(:refund, Orb::Models::CreditNote::Type::TaggedSymbol) ADJUSTMENT = T.let(:adjustment, Orb::Models::CreditNote::Type::TaggedSymbol) @@ -498,8 +531,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNote::Discount::DiscountType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::Discount::DiscountType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PERCENTAGE = T.let(:percentage, Orb::Models::CreditNote::Discount::DiscountType::TaggedSymbol) diff --git a/rbi/lib/orb/models/credit_note_create_params.rbi b/rbi/lib/orb/models/credit_note_create_params.rbi index 5030d917..94a3e77d 100644 --- a/rbi/lib/orb/models/credit_note_create_params.rbi +++ b/rbi/lib/orb/models/credit_note_create_params.rbi @@ -26,8 +26,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(line_items:, memo: nil, reason: nil, request_options: {}); end - + def self.new( + line_items:, + # An optional memo to attach to the credit note. + memo: nil, + # An optional reason for the credit note. + reason: nil, + request_options: {} + ); end sig do override .returns( @@ -51,8 +57,12 @@ module Orb attr_accessor :invoice_line_item_id sig { params(amount: String, invoice_line_item_id: String).returns(T.attached_class) } - def self.new(amount:, invoice_line_item_id:); end - + def self.new( + # The total amount in the invoice's currency to credit this line item. + amount:, + # The ID of the line item to credit. + invoice_line_item_id: + ); end sig { override.returns({amount: String, invoice_line_item_id: String}) } def to_hash; end end @@ -62,8 +72,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNoteCreateParams::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::CreditNoteCreateParams::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } DUPLICATE = T.let(:duplicate, Orb::Models::CreditNoteCreateParams::Reason::TaggedSymbol) FRAUDULENT = T.let(:fraudulent, Orb::Models::CreditNoteCreateParams::Reason::TaggedSymbol) diff --git a/rbi/lib/orb/models/credit_note_list_params.rbi b/rbi/lib/orb/models/credit_note_list_params.rbi index 14acc9a0..c74cc833 100644 --- a/rbi/lib/orb/models/credit_note_list_params.rbi +++ b/rbi/lib/orb/models/credit_note_list_params.rbi @@ -47,7 +47,10 @@ module Orb created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. cursor: nil, + # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} ); end diff --git a/rbi/lib/orb/models/customer.rbi b/rbi/lib/orb/models/customer.rbi index 1168046f..34cf2e37 100644 --- a/rbi/lib/orb/models/customer.rbi +++ b/rbi/lib/orb/models/customer.rbi @@ -278,22 +278,148 @@ module Orb id:, additional_emails:, auto_collection:, + # The customer's current balance in their currency. balance:, billing_address:, created_at:, currency:, + # A valid customer email, to be used for notifications. When Orb triggers payment + # through a payment gateway, this email will be used for any automatically issued + # receipts. email:, email_delivery:, exempt_from_automated_tax:, + # An optional user-defined ID for this customer resource, used throughout the + # system as an alias for this Customer. Use this field to identify a customer by + # an existing identifier in your system. external_customer_id:, + # The hierarchical relationships for this customer. hierarchy:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The full name of the customer name:, + # This is used for creating charges or invoices in an external system via Orb. + # When not in test mode, the connection must first be configured in the Orb + # webapp. payment_provider:, + # The ID of this customer in an external payments solution, such as Stripe. This + # is used for creating charges or invoices in the external system via Orb. payment_provider_id:, portal_url:, shipping_address:, + # Tax IDs are commonly required to be displayed on customer invoices, which are + # added to the headers of invoices. + # + # ### Supported Tax ID Countries and Types + # + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | tax_id:, + # A timezone identifier from the IANA timezone database, such as + # "America/Los_Angeles". This "defaults to your account's timezone if not set. + # This cannot be changed after customer creation. timezone:, accounting_sync_configuration: nil, reporting_configuration: nil @@ -444,7 +570,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customer::PaymentProvider) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Customer::PaymentProvider::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } QUICKBOOKS = T.let(:quickbooks, Orb::Models::Customer::PaymentProvider::TaggedSymbol) BILL_COM = T.let(:"bill.com", Orb::Models::Customer::PaymentProvider::TaggedSymbol) @@ -645,7 +771,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customer::TaxID::Country) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Customer::TaxID::Country::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } AD = T.let(:AD, Orb::Models::Customer::TaxID::Country::TaggedSymbol) AE = T.let(:AE, Orb::Models::Customer::TaxID::Country::TaggedSymbol) @@ -734,7 +860,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customer::TaxID::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Customer::TaxID::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } AD_NRT = T.let(:ad_nrt, Orb::Models::Customer::TaxID::Type::TaggedSymbol) AE_TRN = T.let(:ae_trn, Orb::Models::Customer::TaxID::Type::TaggedSymbol) @@ -876,14 +1002,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } QUICKBOOKS = T.let( diff --git a/rbi/lib/orb/models/customer_create_params.rbi b/rbi/lib/orb/models/customer_create_params.rbi index 3b720d55..4618e6b3 100644 --- a/rbi/lib/orb/models/customer_create_params.rbi +++ b/rbi/lib/orb/models/customer_create_params.rbi @@ -272,23 +272,154 @@ module Orb .returns(T.attached_class) end def self.new( + # A valid customer email, to be used for notifications. When Orb triggers payment + # through a payment gateway, this email will be used for any automatically issued + # receipts. email:, + # The full name of the customer name:, accounting_sync_configuration: nil, + # Additional email addresses for this customer. If populated, these email + # addresses will be CC'd for customer communications. additional_emails: nil, + # Used to determine if invoices for this customer will automatically attempt to + # charge a saved payment method, if available. This parameter defaults to `True` + # when a payment provider is provided on customer creation. auto_collection: nil, billing_address: nil, + # An ISO 4217 currency string used for the customer's invoices and balance. If not + # set at creation time, will be set at subscription creation time. currency: nil, email_delivery: nil, + # An optional user-defined ID for this customer resource, used throughout the + # system as an alias for this Customer. Use this field to identify a customer by + # an existing identifier in your system. external_customer_id: nil, + # The hierarchical relationships for this customer. hierarchy: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # This is used for creating charges or invoices in an external system via Orb. + # When not in test mode, the connection must first be configured in the Orb + # webapp. payment_provider: nil, + # The ID of this customer in an external payments solution, such as Stripe. This + # is used for creating charges or invoices in the external system via Orb. payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, + # Tax IDs are commonly required to be displayed on customer invoices, which are + # added to the headers of invoices. + # + # ### Supported Tax ID Countries and Types + # + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | tax_id: nil, + # A timezone identifier from the IANA timezone database, such as + # `"America/Los_Angeles"`. This defaults to your account's timezone if not set. + # This cannot be changed after customer creation. timezone: nil, request_options: {} ); end @@ -445,8 +576,14 @@ module Orb params(child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)) .returns(T.attached_class) end - def self.new(child_customer_ids: nil, parent_customer_id: nil); end - + def self.new( + # A list of child customer IDs to add to the hierarchy. The desired child + # customers must not already be part of another hierarchy. + child_customer_ids: nil, + # The ID of the parent customer in the hierarchy. The desired parent customer must + # not be a child of another customer. + parent_customer_id: nil + ); end sig do override.returns({child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)}) end @@ -460,8 +597,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerCreateParams::PaymentProvider) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::CustomerCreateParams::PaymentProvider::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } QUICKBOOKS = T.let(:quickbooks, Orb::Models::CustomerCreateParams::PaymentProvider::TaggedSymbol) BILL_COM = T.let(:"bill.com", Orb::Models::CustomerCreateParams::PaymentProvider::TaggedSymbol) @@ -727,8 +863,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerCreateParams::TaxID::Country) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::CustomerCreateParams::TaxID::Country::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } AD = T.let(:AD, Orb::Models::CustomerCreateParams::TaxID::Country::TaggedSymbol) AE = T.let(:AE, Orb::Models::CustomerCreateParams::TaxID::Country::TaggedSymbol) @@ -817,8 +952,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerCreateParams::TaxID::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::CustomerCreateParams::TaxID::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } AD_NRT = T.let(:ad_nrt, Orb::Models::CustomerCreateParams::TaxID::Type::TaggedSymbol) AE_TRN = T.let(:ae_trn, Orb::Models::CustomerCreateParams::TaxID::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/customer_list_params.rbi b/rbi/lib/orb/models/customer_list_params.rbi index 4892498c..3b73a367 100644 --- a/rbi/lib/orb/models/customer_list_params.rbi +++ b/rbi/lib/orb/models/customer_list_params.rbi @@ -47,7 +47,10 @@ module Orb created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. cursor: nil, + # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} ); end diff --git a/rbi/lib/orb/models/customer_update_by_external_id_params.rbi b/rbi/lib/orb/models/customer_update_by_external_id_params.rbi index b6cb5b8e..f27e21e6 100644 --- a/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customer_update_by_external_id_params.rbi @@ -282,21 +282,150 @@ module Orb end def self.new( accounting_sync_configuration: nil, + # Additional email addresses for this customer. If populated, these email + # addresses will be CC'd for customer communications. additional_emails: nil, + # Used to determine if invoices for this customer will automatically attempt to + # charge a saved payment method, if available. This parameter defaults to `True` + # when a payment provider is provided on customer creation. auto_collection: nil, billing_address: nil, + # An ISO 4217 currency string used for the customer's invoices and balance. If not + # set at creation time, will be set at subscription creation time. currency: nil, + # A valid customer email, to be used for invoicing and notifications. email: nil, email_delivery: nil, + # The external customer ID. This can only be set if empty and the customer has no + # past or current subscriptions. external_customer_id: nil, + # The hierarchical relationships for this customer. hierarchy: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # The full name of the customer name: nil, + # This is used for creating charges or invoices in an external system via Orb. + # When not in test mode: + # + # - the connection must first be configured in the Orb webapp. + # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, + # `bill.com`, `netsuite`), any product mappings must first be configured with + # the Orb team. payment_provider: nil, + # The ID of this customer in an external payments solution, such as Stripe. This + # is used for creating charges or invoices in the external system via Orb. payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, + # Tax IDs are commonly required to be displayed on customer invoices, which are + # added to the headers of invoices. + # + # ### Supported Tax ID Countries and Types + # + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | tax_id: nil, request_options: {} ); end @@ -456,8 +585,14 @@ module Orb params(child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)) .returns(T.attached_class) end - def self.new(child_customer_ids: nil, parent_customer_id: nil); end - + def self.new( + # A list of child customer IDs to add to the hierarchy. The desired child + # customers must not already be part of another hierarchy. + child_customer_ids: nil, + # The ID of the parent customer in the hierarchy. The desired parent customer must + # not be a child of another customer. + parent_customer_id: nil + ); end sig do override.returns({child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)}) end @@ -476,8 +611,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } QUICKBOOKS = T.let(:quickbooks, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol) @@ -748,8 +882,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } AD = T.let(:AD, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol) AE = T.let(:AE, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol) @@ -838,8 +971,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } AD_NRT = T.let(:ad_nrt, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol) AE_TRN = T.let(:ae_trn, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/customer_update_params.rbi b/rbi/lib/orb/models/customer_update_params.rbi index 9f2151a8..40059809 100644 --- a/rbi/lib/orb/models/customer_update_params.rbi +++ b/rbi/lib/orb/models/customer_update_params.rbi @@ -267,21 +267,150 @@ module Orb end def self.new( accounting_sync_configuration: nil, + # Additional email addresses for this customer. If populated, these email + # addresses will be CC'd for customer communications. additional_emails: nil, + # Used to determine if invoices for this customer will automatically attempt to + # charge a saved payment method, if available. This parameter defaults to `True` + # when a payment provider is provided on customer creation. auto_collection: nil, billing_address: nil, + # An ISO 4217 currency string used for the customer's invoices and balance. If not + # set at creation time, will be set at subscription creation time. currency: nil, + # A valid customer email, to be used for invoicing and notifications. email: nil, email_delivery: nil, + # The external customer ID. This can only be set if empty and the customer has no + # past or current subscriptions. external_customer_id: nil, + # The hierarchical relationships for this customer. hierarchy: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # The full name of the customer name: nil, + # This is used for creating charges or invoices in an external system via Orb. + # When not in test mode: + # + # - the connection must first be configured in the Orb webapp. + # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, + # `bill.com`, `netsuite`), any product mappings must first be configured with + # the Orb team. payment_provider: nil, + # The ID of this customer in an external payments solution, such as Stripe. This + # is used for creating charges or invoices in the external system via Orb. payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, + # Tax IDs are commonly required to be displayed on customer invoices, which are + # added to the headers of invoices. + # + # ### Supported Tax ID Countries and Types + # + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | tax_id: nil, request_options: {} ); end @@ -437,8 +566,14 @@ module Orb params(child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)) .returns(T.attached_class) end - def self.new(child_customer_ids: nil, parent_customer_id: nil); end - + def self.new( + # A list of child customer IDs to add to the hierarchy. The desired child + # customers must not already be part of another hierarchy. + child_customer_ids: nil, + # The ID of the parent customer in the hierarchy. The desired parent customer must + # not be a child of another customer. + parent_customer_id: nil + ); end sig do override.returns({child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)}) end @@ -456,8 +591,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } QUICKBOOKS = T.let(:quickbooks, Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol) BILL_COM = T.let(:"bill.com", Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol) @@ -723,8 +857,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } AD = T.let(:AD, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol) AE = T.let(:AE, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol) @@ -813,8 +946,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } AD_NRT = T.let(:ad_nrt, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol) AE_TRN = T.let(:ae_trn, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi b/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi index 6025b3ee..e5619d57 100644 --- a/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +++ b/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi @@ -26,8 +26,13 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, type:, description: nil, request_options: {}); end - + def self.new( + amount:, + type:, + # An optional description that can be specified around this entry. + description: nil, + request_options: {} + ); end sig do override .returns( @@ -46,8 +51,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INCREMENT = T.let(:increment, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol) DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi b/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi index f7449a06..2db6d277 100644 --- a/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +++ b/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi @@ -82,14 +82,22 @@ module Orb .returns(T.attached_class) end def self.new( + # A unique id for this transaction. id:, action:, + # The value of the amount changed in the transaction. amount:, + # The creation time of this transaction. created_at:, credit_note:, + # An optional description provided for manual customer balance adjustments. description:, + # The new value of the customer's balance prior to the transaction, in the + # customer's currency. ending_balance:, invoice:, + # The original value of the customer's balance prior to the transaction, in the + # customer's currency. starting_balance:, type: ); end @@ -117,8 +125,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Action) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } APPLIED_TO_INVOICE = T.let(:applied_to_invoice, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol) @@ -158,8 +165,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:); end - + def self.new( + # The id of the Credit note + id: + ); end sig { override.returns({id: String}) } def to_hash; end end @@ -170,8 +179,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:); end - + def self.new( + # The Invoice id + id: + ); end sig { override.returns({id: String}) } def to_hash; end end @@ -181,8 +192,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INCREMENT = T.let(:increment, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi b/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi index 514551fb..1cf1ff5a 100644 --- a/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +++ b/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi @@ -44,7 +44,10 @@ module Orb .returns(T.attached_class) end def self.new( + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. cursor: nil, + # The number of items to fetch. Defaults to 20. limit: nil, operation_time_gt: nil, operation_time_gte: nil, diff --git a/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi b/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi index bd94dca4..fce9b590 100644 --- a/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +++ b/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi @@ -78,14 +78,22 @@ module Orb .returns(T.attached_class) end def self.new( + # A unique id for this transaction. id:, action:, + # The value of the amount changed in the transaction. amount:, + # The creation time of this transaction. created_at:, credit_note:, + # An optional description provided for manual customer balance adjustments. description:, + # The new value of the customer's balance prior to the transaction, in the + # customer's currency. ending_balance:, invoice:, + # The original value of the customer's balance prior to the transaction, in the + # customer's currency. starting_balance:, type: ); end @@ -113,8 +121,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Action) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } APPLIED_TO_INVOICE = T.let(:applied_to_invoice, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol) @@ -148,8 +155,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:); end - + def self.new( + # The id of the Credit note + id: + ); end sig { override.returns({id: String}) } def to_hash; end end @@ -160,8 +169,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:); end - + def self.new( + # The Invoice id + id: + ); end sig { override.returns({id: String}) } def to_hash; end end @@ -171,8 +182,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INCREMENT = T.let(:increment, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol) DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi b/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi index 95db8bdf..748c0a72 100644 --- a/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi @@ -37,14 +37,19 @@ module Orb .returns(T.attached_class) end def self.new( + # The currency or custom pricing unit to use. currency: nil, + # Costs returned are exclusive of `timeframe_end`. timeframe_end: nil, + # Costs returned are inclusive of `timeframe_start`. timeframe_start: nil, + # Controls whether Orb returns cumulative costs since the start of the billing + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. view_mode: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -68,8 +73,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PERIODIC = T.let(:periodic, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol) CUMULATIVE = diff --git a/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi b/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi index 73edc7d0..bfc2f47c 100644 --- a/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi @@ -46,8 +46,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:); end - + def self.new( + per_price_costs:, + # Total costs for the timeframe, excluding any minimums and discounts. + subtotal:, + timeframe_end:, + timeframe_start:, + # Total costs for the timeframe, including any minimums and discounts. + total: + ); end sig do override .returns( @@ -156,8 +163,18 @@ module Orb ) .returns(T.attached_class) end - def self.new(price:, price_id:, subtotal:, total:, quantity: nil); end - + def self.new( + # The price object + price:, + # The price the cost is associated with + price_id:, + # Price's contributions for the timeframe, excluding any minimums and discounts. + subtotal:, + # Price's contributions for the timeframe, including minimums and discounts. + total:, + # The price's quantity for the timeframe + quantity: nil + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/customers/cost_list_params.rbi b/rbi/lib/orb/models/customers/cost_list_params.rbi index eeddc27d..3bf1d490 100644 --- a/rbi/lib/orb/models/customers/cost_list_params.rbi +++ b/rbi/lib/orb/models/customers/cost_list_params.rbi @@ -37,14 +37,19 @@ module Orb .returns(T.attached_class) end def self.new( + # The currency or custom pricing unit to use. currency: nil, + # Costs returned are exclusive of `timeframe_end`. timeframe_end: nil, + # Costs returned are inclusive of `timeframe_start`. timeframe_start: nil, + # Controls whether Orb returns cumulative costs since the start of the billing + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. view_mode: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -67,8 +72,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::CostListParams::ViewMode) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CostListParams::ViewMode::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PERIODIC = T.let(:periodic, Orb::Models::Customers::CostListParams::ViewMode::TaggedSymbol) CUMULATIVE = T.let(:cumulative, Orb::Models::Customers::CostListParams::ViewMode::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/cost_list_response.rbi b/rbi/lib/orb/models/customers/cost_list_response.rbi index 3220241a..caaaae8d 100644 --- a/rbi/lib/orb/models/customers/cost_list_response.rbi +++ b/rbi/lib/orb/models/customers/cost_list_response.rbi @@ -44,8 +44,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:); end - + def self.new( + per_price_costs:, + # Total costs for the timeframe, excluding any minimums and discounts. + subtotal:, + timeframe_end:, + timeframe_start:, + # Total costs for the timeframe, including any minimums and discounts. + total: + ); end sig do override .returns( @@ -154,8 +161,18 @@ module Orb ) .returns(T.attached_class) end - def self.new(price:, price_id:, subtotal:, total:, quantity: nil); end - + def self.new( + # The price object + price:, + # The price the cost is associated with + price_id:, + # Price's contributions for the timeframe, excluding any minimums and discounts. + subtotal:, + # Price's contributions for the timeframe, including minimums and discounts. + total:, + # The price's quantity for the timeframe + quantity: nil + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi index 51600664..3a9e5e6f 100644 --- a/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi @@ -41,9 +41,19 @@ module Orb ) .returns(T.attached_class) end - def self.new(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}) - end - + def self.new( + # The ledger currency or custom pricing unit to use. + currency: nil, + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. + cursor: nil, + # If set to True, all expired and depleted blocks, as well as active block will be + # returned. + include_all_blocks: nil, + # The number of items to fetch. Defaults to 20. + limit: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi index 3cba78de..dcfa7abf 100644 --- a/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi @@ -69,8 +69,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol) PENDING_PAYMENT = diff --git a/rbi/lib/orb/models/customers/credit_list_params.rbi b/rbi/lib/orb/models/customers/credit_list_params.rbi index 806470ec..e64a06b2 100644 --- a/rbi/lib/orb/models/customers/credit_list_params.rbi +++ b/rbi/lib/orb/models/customers/credit_list_params.rbi @@ -41,9 +41,19 @@ module Orb ) .returns(T.attached_class) end - def self.new(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}) - end - + def self.new( + # The ledger currency or custom pricing unit to use. + currency: nil, + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. + cursor: nil, + # If set to True, all expired and depleted blocks, as well as active block will be + # returned. + include_all_blocks: nil, + # The number of items to fetch. Defaults to 20. + limit: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/customers/credit_list_response.rbi b/rbi/lib/orb/models/customers/credit_list_response.rbi index e5b78953..cc3d88db 100644 --- a/rbi/lib/orb/models/customers/credit_list_response.rbi +++ b/rbi/lib/orb/models/customers/credit_list_response.rbi @@ -68,8 +68,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::CreditListResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol) PENDING_PAYMENT = diff --git a/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi index 25b77751..794f4297 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi @@ -109,17 +109,41 @@ module Orb .returns(T.attached_class) end def self.new( + # The number of credits to effect. Note that this is required for increment, + # decrement or void operations. amount:, entry_type:, + # An ISO 8601 format date that identifies the origination credit block to expire expiry_date:, + # A future date (specified in YYYY-MM-DD format) used for expiration change, + # denoting when credits transferred (as part of a partial block expiration) should + # expire. target_expiry_date:, + # The ID of the block to reverse a decrement from. block_id:, + # The currency or custom pricing unit to use for this ledger entry. If this is a + # real-world currency, it must match the customer's invoicing currency. currency: nil, + # Optional metadata that can be specified when adding ledger results via the API. + # For example, this can be used to note an increment refers to trial credits, or + # for noting corrections as a result of an incident, etc. description: nil, + # An ISO 8601 format date that denotes when this credit balance should become + # available for use. effective_date: nil, + # Passing `invoice_settings` automatically generates an invoice for the newly + # added credits. If `invoice_settings` is passed, you must specify + # per_unit_cost_basis, as the calculation of the invoice total is done on that + # basis. invoice_settings: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # Can only be specified when entry_type=increment. How much, in the customer's + # currency, a customer paid for a single credit in this block per_unit_cost_basis: nil, + # Can only be specified when `entry_type=void`. The reason for the void. void_reason: nil, request_options: {} ); end @@ -150,14 +174,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } AMENDMENT = T.let( @@ -211,8 +228,20 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end - + def self.new( + # Whether the credits purchase invoice should auto collect with the customer's + # saved payment method. + auto_collection:, + # The net terms determines the difference between the invoice date and the issue + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. + net_terms:, + # An optional memo to display on the invoice. + memo: nil, + # If true, the new credit block will require that the corresponding invoice is + # paid before it can be drawn down from. + require_successful_payment: nil + ); end sig do override .returns( @@ -233,14 +262,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } REFUND = T.let( diff --git a/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi index 5c2422a1..4a59250c 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi @@ -122,6 +122,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, entry_type: :increment @@ -197,14 +201,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -354,6 +351,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, event_id: nil, @@ -435,14 +436,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -584,6 +578,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, new_block_expiry_date:, starting_balance:, @@ -661,14 +659,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -806,6 +797,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, entry_type: :credit_block_expiry @@ -881,14 +876,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -1030,6 +1018,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, void_amount:, @@ -1109,14 +1101,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -1266,6 +1251,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, new_block_expiry_date:, starting_balance:, @@ -1347,14 +1336,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -1492,6 +1474,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, entry_type: :amendment @@ -1567,14 +1553,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( diff --git a/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi b/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi index a258f7b6..379b683f 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi @@ -99,17 +99,41 @@ module Orb .returns(T.attached_class) end def self.new( + # The number of credits to effect. Note that this is required for increment, + # decrement or void operations. amount:, entry_type:, + # An ISO 8601 format date that identifies the origination credit block to expire expiry_date:, + # A future date (specified in YYYY-MM-DD format) used for expiration change, + # denoting when credits transferred (as part of a partial block expiration) should + # expire. target_expiry_date:, + # The ID of the block to reverse a decrement from. block_id:, + # The currency or custom pricing unit to use for this ledger entry. If this is a + # real-world currency, it must match the customer's invoicing currency. currency: nil, + # Optional metadata that can be specified when adding ledger results via the API. + # For example, this can be used to note an increment refers to trial credits, or + # for noting corrections as a result of an incident, etc. description: nil, + # An ISO 8601 format date that denotes when this credit balance should become + # available for use. effective_date: nil, + # Passing `invoice_settings` automatically generates an invoice for the newly + # added credits. If `invoice_settings` is passed, you must specify + # per_unit_cost_basis, as the calculation of the invoice total is done on that + # basis. invoice_settings: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # Can only be specified when entry_type=increment. How much, in the customer's + # currency, a customer paid for a single credit in this block per_unit_cost_basis: nil, + # Can only be specified when `entry_type=void`. The reason for the void. void_reason: nil, request_options: {} ); end @@ -140,8 +164,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } AMENDMENT = T.let(:amendment, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType::TaggedSymbol) @@ -190,8 +213,20 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end - + def self.new( + # Whether the credits purchase invoice should auto collect with the customer's + # saved payment method. + auto_collection:, + # The net terms determines the difference between the invoice date and the issue + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. + net_terms:, + # An optional memo to display on the invoice. + memo: nil, + # If true, the new credit block will require that the corresponding invoice is + # paid before it can be drawn down from. + require_successful_payment: nil + ); end sig do override .returns( @@ -212,8 +247,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } REFUND = T.let(:refund, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi index e71029c7..3ad0c94c 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi @@ -114,6 +114,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, entry_type: :increment @@ -189,14 +193,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -338,6 +335,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, event_id: nil, @@ -419,14 +420,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -564,6 +558,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, new_block_expiry_date:, starting_balance:, @@ -641,14 +639,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -786,6 +777,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, entry_type: :credit_block_expiry @@ -861,14 +856,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -1006,6 +994,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, void_amount:, @@ -1083,14 +1075,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::EntryStatus) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -1230,6 +1215,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, new_block_expiry_date:, starting_balance:, @@ -1311,14 +1300,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -1448,6 +1430,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, entry_type: :amendment @@ -1523,14 +1509,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( diff --git a/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi index 039f9828..3961ce11 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi @@ -66,10 +66,14 @@ module Orb created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, + # The ledger currency or custom pricing unit to use. currency: nil, + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. cursor: nil, entry_status: nil, entry_type: nil, + # The number of items to fetch. Defaults to 20. limit: nil, minimum_amount: nil, request_options: {} @@ -99,14 +103,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -130,14 +127,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } INCREMENT = T.let(:increment, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi index 7e301c23..486f9a24 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi @@ -118,6 +118,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, entry_type: :increment @@ -193,14 +197,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -346,6 +343,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, event_id: nil, @@ -427,14 +428,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -576,6 +570,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, new_block_expiry_date:, starting_balance:, @@ -653,14 +651,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -798,6 +789,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, entry_type: :credit_block_expiry @@ -873,14 +868,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -1018,6 +1006,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, void_amount:, @@ -1097,14 +1089,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -1254,6 +1239,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, new_block_expiry_date:, starting_balance:, @@ -1335,14 +1324,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -1476,6 +1458,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, entry_type: :amendment @@ -1551,14 +1537,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( diff --git a/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi b/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi index a95a4a24..1fce087c 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi @@ -66,10 +66,14 @@ module Orb created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, + # The ledger currency or custom pricing unit to use. currency: nil, + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. cursor: nil, entry_status: nil, entry_type: nil, + # The number of items to fetch. Defaults to 20. limit: nil, minimum_amount: nil, request_options: {} @@ -99,8 +103,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let(:committed, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus::TaggedSymbol) @@ -115,8 +118,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::LedgerListParams::EntryType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INCREMENT = T.let(:increment, Orb::Models::Customers::Credits::LedgerListParams::EntryType::TaggedSymbol) DECREMENT = T.let(:decrement, Orb::Models::Customers::Credits::LedgerListParams::EntryType::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi index 8668a3c5..31ef6435 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi @@ -114,6 +114,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, entry_type: :increment @@ -187,14 +191,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::EntryStatus) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -334,6 +331,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, event_id: nil, @@ -413,14 +414,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::EntryStatus) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -552,6 +546,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, new_block_expiry_date:, starting_balance:, @@ -629,14 +627,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -766,6 +757,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, entry_type: :credit_block_expiry @@ -841,14 +836,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::EntryStatus) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -982,6 +970,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, void_amount:, @@ -1059,14 +1051,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::EntryStatus) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -1206,6 +1191,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, new_block_expiry_date:, starting_balance:, @@ -1285,14 +1274,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::EntryStatus) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( @@ -1420,6 +1402,10 @@ module Orb ending_balance:, entry_status:, ledger_sequence_number:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, starting_balance:, entry_type: :amendment @@ -1493,14 +1479,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::EntryStatus) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } COMMITTED = T.let( diff --git a/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi index e83dcc6e..522f13d0 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi @@ -77,13 +77,25 @@ module Orb .returns(T.attached_class) end def self.new( + # The amount to increment when the threshold is reached. amount:, + # The currency or custom pricing unit to use for this top-up. If this is a + # real-world currency, it must match the customer's invoicing currency. currency:, + # Settings for invoices generated by triggered top-ups. invoice_settings:, + # How much, in the customer's currency, to charge for each unit. per_unit_cost_basis:, + # The threshold at which to trigger the top-up. If the balance is at or below this + # threshold, the top-up will be triggered. threshold:, + # The date from which the top-up is active. If unspecified, the top-up is active + # immediately. active_from: nil, + # The number of days or months after which the top-up expires. If unspecified, it + # does not expire. expires_after: nil, + # The unit of expires_after. expires_after_unit: nil, request_options: {} ); end @@ -139,8 +151,20 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end - + def self.new( + # Whether the credits purchase invoice should auto collect with the customer's + # saved payment method. + auto_collection:, + # The net terms determines the difference between the invoice date and the issue + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. + net_terms:, + # An optional memo to display on the invoice. + memo: nil, + # If true, new credit blocks created by this top-up will require that the + # corresponding invoice is paid before they can be drawn down from. + require_successful_payment: nil + ); end sig do override .returns( @@ -161,14 +185,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( diff --git a/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi index a91b0b9b..91ce13eb 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi @@ -74,12 +74,22 @@ module Orb end def self.new( id:, + # The amount to increment when the threshold is reached. amount:, + # The currency or custom pricing unit to use for this top-up. If this is a + # real-world currency, it must match the customer's invoicing currency. currency:, + # Settings for invoices generated by triggered top-ups. invoice_settings:, + # How much, in the customer's currency, to charge for each unit. per_unit_cost_basis:, + # The threshold at which to trigger the top-up. If the balance is at or below this + # threshold, the top-up will be triggered. threshold:, + # The number of days or months after which the top-up expires. If unspecified, it + # does not expire. expires_after: nil, + # The unit of expires_after. expires_after_unit: nil ); end sig do @@ -135,8 +145,20 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end - + def self.new( + # Whether the credits purchase invoice should auto collect with the customer's + # saved payment method. + auto_collection:, + # The net terms determines the difference between the invoice date and the issue + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. + net_terms:, + # An optional memo to display on the invoice. + memo: nil, + # If true, new credit blocks created by this top-up will require that the + # corresponding invoice is paid before they can be drawn down from. + require_successful_payment: nil + ); end sig do override .returns( @@ -157,14 +179,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( diff --git a/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi b/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi index 59b790a3..794e129d 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi @@ -67,13 +67,25 @@ module Orb .returns(T.attached_class) end def self.new( + # The amount to increment when the threshold is reached. amount:, + # The currency or custom pricing unit to use for this top-up. If this is a + # real-world currency, it must match the customer's invoicing currency. currency:, + # Settings for invoices generated by triggered top-ups. invoice_settings:, + # How much, in the customer's currency, to charge for each unit. per_unit_cost_basis:, + # The threshold at which to trigger the top-up. If the balance is at or below this + # threshold, the top-up will be triggered. threshold:, + # The date from which the top-up is active. If unspecified, the top-up is active + # immediately. active_from: nil, + # The number of days or months after which the top-up expires. If unspecified, it + # does not expire. expires_after: nil, + # The unit of expires_after. expires_after_unit: nil, request_options: {} ); end @@ -129,8 +141,20 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end - + def self.new( + # Whether the credits purchase invoice should auto collect with the customer's + # saved payment method. + auto_collection:, + # The net terms determines the difference between the invoice date and the issue + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. + net_terms:, + # An optional memo to display on the invoice. + memo: nil, + # If true, new credit blocks created by this top-up will require that the + # corresponding invoice is paid before they can be drawn down from. + require_successful_payment: nil + ); end sig do override .returns( @@ -151,8 +175,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol) MONTH = T.let(:month, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi b/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi index a96beb29..d22c6145 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi @@ -62,12 +62,22 @@ module Orb end def self.new( id:, + # The amount to increment when the threshold is reached. amount:, + # The currency or custom pricing unit to use for this top-up. If this is a + # real-world currency, it must match the customer's invoicing currency. currency:, + # Settings for invoices generated by triggered top-ups. invoice_settings:, + # How much, in the customer's currency, to charge for each unit. per_unit_cost_basis:, + # The threshold at which to trigger the top-up. If the balance is at or below this + # threshold, the top-up will be triggered. threshold:, + # The number of days or months after which the top-up expires. If unspecified, it + # does not expire. expires_after: nil, + # The unit of expires_after. expires_after_unit: nil ); end sig do @@ -121,8 +131,20 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end - + def self.new( + # Whether the credits purchase invoice should auto collect with the customer's + # saved payment method. + auto_collection:, + # The net terms determines the difference between the invoice date and the issue + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. + net_terms:, + # An optional memo to display on the invoice. + memo: nil, + # If true, new credit blocks created by this top-up will require that the + # corresponding invoice is paid before they can be drawn down from. + require_successful_payment: nil + ); end sig do override .returns( @@ -143,14 +165,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit::TaggedSymbol) MONTH = diff --git a/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi index f3ae38cb..4588563c 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi @@ -28,8 +28,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}); end - + def self.new( + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. + cursor: nil, + # The number of items to fetch. Defaults to 20. + limit: nil, + request_options: {} + ); end sig do override.returns( { diff --git a/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi index c767f7ac..a4f0cc6b 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi @@ -72,12 +72,22 @@ module Orb end def self.new( id:, + # The amount to increment when the threshold is reached. amount:, + # The currency or custom pricing unit to use for this top-up. If this is a + # real-world currency, it must match the customer's invoicing currency. currency:, + # Settings for invoices generated by triggered top-ups. invoice_settings:, + # How much, in the customer's currency, to charge for each unit. per_unit_cost_basis:, + # The threshold at which to trigger the top-up. If the balance is at or below this + # threshold, the top-up will be triggered. threshold:, + # The number of days or months after which the top-up expires. If unspecified, it + # does not expire. expires_after: nil, + # The unit of expires_after. expires_after_unit: nil ); end sig do @@ -131,8 +141,20 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end - + def self.new( + # Whether the credits purchase invoice should auto collect with the customer's + # saved payment method. + auto_collection:, + # The net terms determines the difference between the invoice date and the issue + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. + net_terms:, + # An optional memo to display on the invoice. + memo: nil, + # If true, new credit blocks created by this top-up will require that the + # corresponding invoice is paid before they can be drawn down from. + require_successful_payment: nil + ); end sig do override .returns( @@ -153,14 +175,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( diff --git a/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi b/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi index b8aa06f4..e4e6e3d2 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi @@ -28,8 +28,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}); end - + def self.new( + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. + cursor: nil, + # The number of items to fetch. Defaults to 20. + limit: nil, + request_options: {} + ); end sig do override.returns( { diff --git a/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi b/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi index f026fd78..528fb016 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi @@ -62,12 +62,22 @@ module Orb end def self.new( id:, + # The amount to increment when the threshold is reached. amount:, + # The currency or custom pricing unit to use for this top-up. If this is a + # real-world currency, it must match the customer's invoicing currency. currency:, + # Settings for invoices generated by triggered top-ups. invoice_settings:, + # How much, in the customer's currency, to charge for each unit. per_unit_cost_basis:, + # The threshold at which to trigger the top-up. If the balance is at or below this + # threshold, the top-up will be triggered. threshold:, + # The number of days or months after which the top-up expires. If unspecified, it + # does not expire. expires_after: nil, + # The unit of expires_after. expires_after_unit: nil ); end sig do @@ -121,8 +131,20 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end - + def self.new( + # Whether the credits purchase invoice should auto collect with the customer's + # saved payment method. + auto_collection:, + # The net terms determines the difference between the invoice date and the issue + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. + net_terms:, + # An optional memo to display on the invoice. + memo: nil, + # If true, new credit blocks created by this top-up will require that the + # corresponding invoice is paid before they can be drawn down from. + require_successful_payment: nil + ); end sig do override .returns( @@ -143,8 +165,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit::TaggedSymbol) MONTH = T.let(:month, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit::TaggedSymbol) diff --git a/rbi/lib/orb/models/dimensional_price_group.rbi b/rbi/lib/orb/models/dimensional_price_group.rbi index 9ffc2a09..c2d40c09 100644 --- a/rbi/lib/orb/models/dimensional_price_group.rbi +++ b/rbi/lib/orb/models/dimensional_price_group.rbi @@ -47,14 +47,22 @@ module Orb end def self.new( id:, + # The billable metric associated with this dimensional price group. All prices + # associated with this dimensional price group will be computed using this + # billable metric. billable_metric_id:, + # The dimensions that this dimensional price group is defined over dimensions:, + # An alias for the dimensional price group external_dimensional_price_group_id:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The name of the dimensional price group name: - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/dimensional_price_group_create_params.rbi b/rbi/lib/orb/models/dimensional_price_group_create_params.rbi index 38ded0a4..b3bed31b 100644 --- a/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +++ b/rbi/lib/orb/models/dimensional_price_group_create_params.rbi @@ -38,9 +38,13 @@ module Orb end def self.new( billable_metric_id:, + # The set of keys (in order) used to disambiguate prices in the group. dimensions:, name:, external_dimensional_price_group_id: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, request_options: {} ); end diff --git a/rbi/lib/orb/models/dimensional_price_group_list_params.rbi b/rbi/lib/orb/models/dimensional_price_group_list_params.rbi index 99e1de10..20e2141e 100644 --- a/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +++ b/rbi/lib/orb/models/dimensional_price_group_list_params.rbi @@ -26,8 +26,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}); end - + def self.new( + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. + cursor: nil, + # The number of items to fetch. Defaults to 20. + limit: nil, + request_options: {} + ); end sig do override.returns({cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOptions}) end diff --git a/rbi/lib/orb/models/evaluate_price_group.rbi b/rbi/lib/orb/models/evaluate_price_group.rbi index 19b59b06..fdddc721 100644 --- a/rbi/lib/orb/models/evaluate_price_group.rbi +++ b/rbi/lib/orb/models/evaluate_price_group.rbi @@ -19,8 +19,14 @@ module Orb params(amount: String, grouping_values: T::Array[T.any(String, Float, T::Boolean)], quantity: Float) .returns(T.attached_class) end - def self.new(amount:, grouping_values:, quantity:); end - + def self.new( + # The price's output for the group + amount:, + # The values for the group in the order specified by `grouping_keys` + grouping_values:, + # The price's usage quantity for the group + quantity: + ); end sig do override .returns({ diff --git a/rbi/lib/orb/models/event_deprecate_response.rbi b/rbi/lib/orb/models/event_deprecate_response.rbi index 191ad0bf..72085c2e 100644 --- a/rbi/lib/orb/models/event_deprecate_response.rbi +++ b/rbi/lib/orb/models/event_deprecate_response.rbi @@ -8,8 +8,10 @@ module Orb attr_accessor :deprecated sig { params(deprecated: String).returns(T.attached_class) } - def self.new(deprecated:); end - + def self.new( + # event_id of the deprecated event, if successfully updated + deprecated: + ); end sig { override.returns({deprecated: String}) } def to_hash; end end diff --git a/rbi/lib/orb/models/event_ingest_params.rbi b/rbi/lib/orb/models/event_ingest_params.rbi index f32c08f0..48dd475e 100644 --- a/rbi/lib/orb/models/event_ingest_params.rbi +++ b/rbi/lib/orb/models/event_ingest_params.rbi @@ -30,8 +30,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(events:, backfill_id: nil, debug: nil, request_options: {}); end - + def self.new( + events:, + # If this ingestion request is part of a backfill, this parameter ties the + # ingested events to the backfill + backfill_id: nil, + # Flag to enable additional debug information in the endpoint response + debug: nil, + request_options: {} + ); end sig do override .returns( @@ -88,15 +95,25 @@ module Orb .returns(T.attached_class) end def self.new( + # A name to meaningfully identify the action or event type. event_name:, + # A unique value, generated by the client, that is used to de-duplicate events. + # Exactly one event with a given idempotency key will be ingested, which allows + # for safe request retries. idempotency_key:, + # A dictionary of custom properties. Values in this dictionary must be numeric, + # boolean, or strings. Nested dictionaries are disallowed. properties:, + # An ISO 8601 format date with no timezone offset (i.e. UTC). This should + # represent the time that usage was recorded, and is particularly important to + # attribute usage to a given billing period. timestamp:, + # The Orb Customer identifier customer_id: nil, + # An alias for the Orb customer, whose mapping is specified when creating the + # customer external_customer_id: nil - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/event_ingest_response.rbi b/rbi/lib/orb/models/event_ingest_response.rbi index c1e84491..c039351f 100644 --- a/rbi/lib/orb/models/event_ingest_response.rbi +++ b/rbi/lib/orb/models/event_ingest_response.rbi @@ -23,8 +23,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(validation_failed:, debug: nil); end - + def self.new( + # Contains all failing validation events. In the case of a 200, this array will + # always be empty. This field will always be present. + validation_failed:, + # Optional debug information (only present when debug=true is passed to the + # endpoint). Contains ingested and duplicate event idempotency keys. + debug: nil + ); end sig do override .returns( @@ -47,8 +53,13 @@ module Orb attr_accessor :validation_errors sig { params(idempotency_key: String, validation_errors: T::Array[String]).returns(T.attached_class) } - def self.new(idempotency_key:, validation_errors:); end - + def self.new( + # The passed idempotency_key corresponding to the validation_errors + idempotency_key:, + # An array of strings corresponding to validation failures for this + # idempotency_key. + validation_errors: + ); end sig { override.returns({idempotency_key: String, validation_errors: T::Array[String]}) } def to_hash; end end diff --git a/rbi/lib/orb/models/event_search_params.rbi b/rbi/lib/orb/models/event_search_params.rbi index 43be508f..e1d58623 100644 --- a/rbi/lib/orb/models/event_search_params.rbi +++ b/rbi/lib/orb/models/event_search_params.rbi @@ -32,8 +32,20 @@ module Orb ) .returns(T.attached_class) end - def self.new(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {}); end - + def self.new( + # This is an explicit array of IDs to filter by. Note that an event's ID is the + # idempotency_key that was originally used for ingestion, and this only supports + # events that have not been amended. Values in this array will be treated case + # sensitively. + event_ids:, + # The end of the timeframe, exclusive, in which to search events. If not + # specified, the current time is used. + timeframe_end: nil, + # The start of the timeframe, inclusive, in which to search events. If not + # specified, the one week ago is used. + timeframe_start: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/event_search_response.rbi b/rbi/lib/orb/models/event_search_response.rbi index 82e44551..28e1c543 100644 --- a/rbi/lib/orb/models/event_search_response.rbi +++ b/rbi/lib/orb/models/event_search_response.rbi @@ -66,16 +66,27 @@ module Orb .returns(T.attached_class) end def self.new( + # A unique value, generated by the client, that is used to de-duplicate events. + # Exactly one event with a given idempotency key will be ingested, which allows + # for safe request retries. id:, + # The Orb Customer identifier customer_id:, + # A boolean indicating whether the event is currently deprecated. deprecated:, + # A name to meaningfully identify the action or event type. event_name:, + # An alias for the Orb customer, whose mapping is specified when creating the + # customer external_customer_id:, + # A dictionary of custom properties. Values in this dictionary must be numeric, + # boolean, or strings. Nested dictionaries are disallowed. properties:, + # An ISO 8601 format date with no timezone offset (i.e. UTC). This should + # represent the time that usage was recorded, and is particularly important to + # attribute usage to a given billing period. timestamp: - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/event_update_params.rbi b/rbi/lib/orb/models/event_update_params.rbi index f19d227a..70d1fd77 100644 --- a/rbi/lib/orb/models/event_update_params.rbi +++ b/rbi/lib/orb/models/event_update_params.rbi @@ -42,15 +42,22 @@ module Orb .returns(T.attached_class) end def self.new( + # A name to meaningfully identify the action or event type. event_name:, + # A dictionary of custom properties. Values in this dictionary must be numeric, + # boolean, or strings. Nested dictionaries are disallowed. properties:, + # An ISO 8601 format date with no timezone offset (i.e. UTC). This should + # represent the time that usage was recorded, and is particularly important to + # attribute usage to a given billing period. timestamp:, + # The Orb Customer identifier customer_id: nil, + # An alias for the Orb customer, whose mapping is specified when creating the + # customer external_customer_id: nil, request_options: {} - ) - end - + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/event_update_response.rbi b/rbi/lib/orb/models/event_update_response.rbi index 992924be..a3dfd9ed 100644 --- a/rbi/lib/orb/models/event_update_response.rbi +++ b/rbi/lib/orb/models/event_update_response.rbi @@ -8,8 +8,10 @@ module Orb attr_accessor :amended sig { params(amended: String).returns(T.attached_class) } - def self.new(amended:); end - + def self.new( + # event_id of the amended event, if successfully ingested + amended: + ); end sig { override.returns({amended: String}) } def to_hash; end end diff --git a/rbi/lib/orb/models/events/backfill_close_response.rbi b/rbi/lib/orb/models/events/backfill_close_response.rbi index c5e587f1..c79c4582 100644 --- a/rbi/lib/orb/models/events/backfill_close_response.rbi +++ b/rbi/lib/orb/models/events/backfill_close_response.rbi @@ -70,15 +70,28 @@ module Orb end def self.new( id:, + # If in the future, the time at which the backfill will automatically close. If in + # the past, the time at which the backfill was closed. close_time:, created_at:, + # The Orb-generated ID of the customer to which this backfill is scoped. If + # `null`, this backfill is scoped to all customers. customer_id:, + # The number of events ingested in this backfill. events_ingested:, + # If `true`, existing events in the backfill's timeframe will be replaced with the + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. replace_existing_events:, + # The time at which this backfill was reverted. reverted_at:, + # The status of the backfill. status:, timeframe_end:, timeframe_start:, + # A boolean + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate deprecation_filter: nil ); end sig do @@ -106,8 +119,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillCloseResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PENDING = T.let(:pending, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol) REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/events/backfill_create_params.rbi b/rbi/lib/orb/models/events/backfill_create_params.rbi index c7d70673..9b8ae17a 100644 --- a/rbi/lib/orb/models/events/backfill_create_params.rbi +++ b/rbi/lib/orb/models/events/backfill_create_params.rbi @@ -63,12 +63,30 @@ module Orb .returns(T.attached_class) end def self.new( + # The (exclusive) end of the usage timeframe affected by this backfill. By + # default, Orb allows backfills up to 10 days in duration at a time. Reach out to + # discuss extending this limit and your use case. timeframe_end:, + # The (inclusive) start of the usage timeframe affected by this backfill. By + # default, Orb allows backfills up to 10 days in duration at a time. Reach out to + # discuss extending this limit and your use case. timeframe_start:, + # The time at which no more events will be accepted for this backfill. The + # backfill will automatically begin reflecting throughout Orb at the close time. + # If not specified, it will default to 1 day after the creation of the backfill. close_time: nil, + # The Orb-generated ID of the customer to which this backfill is scoped. Omitting + # this field will scope the backfill to all customers. customer_id: nil, + # A boolean + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate deprecation_filter: nil, + # The external customer ID of the customer to which this backfill is scoped. + # Omitting this field will scope the backfill to all customers. external_customer_id: nil, + # If true, replaces all existing events in the timeframe with the newly ingested + # events. If false, adds the newly ingested events to the existing events. replace_existing_events: nil, request_options: {} ); end diff --git a/rbi/lib/orb/models/events/backfill_create_response.rbi b/rbi/lib/orb/models/events/backfill_create_response.rbi index 958af8f1..5a6b9e4e 100644 --- a/rbi/lib/orb/models/events/backfill_create_response.rbi +++ b/rbi/lib/orb/models/events/backfill_create_response.rbi @@ -70,15 +70,28 @@ module Orb end def self.new( id:, + # If in the future, the time at which the backfill will automatically close. If in + # the past, the time at which the backfill was closed. close_time:, created_at:, + # The Orb-generated ID of the customer to which this backfill is scoped. If + # `null`, this backfill is scoped to all customers. customer_id:, + # The number of events ingested in this backfill. events_ingested:, + # If `true`, existing events in the backfill's timeframe will be replaced with the + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. replace_existing_events:, + # The time at which this backfill was reverted. reverted_at:, + # The status of the backfill. status:, timeframe_end:, timeframe_start:, + # A boolean + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate deprecation_filter: nil ); end sig do @@ -106,8 +119,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillCreateResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PENDING = T.let(:pending, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol) REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/events/backfill_fetch_response.rbi b/rbi/lib/orb/models/events/backfill_fetch_response.rbi index 0a18ce81..444ff817 100644 --- a/rbi/lib/orb/models/events/backfill_fetch_response.rbi +++ b/rbi/lib/orb/models/events/backfill_fetch_response.rbi @@ -70,15 +70,28 @@ module Orb end def self.new( id:, + # If in the future, the time at which the backfill will automatically close. If in + # the past, the time at which the backfill was closed. close_time:, created_at:, + # The Orb-generated ID of the customer to which this backfill is scoped. If + # `null`, this backfill is scoped to all customers. customer_id:, + # The number of events ingested in this backfill. events_ingested:, + # If `true`, existing events in the backfill's timeframe will be replaced with the + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. replace_existing_events:, + # The time at which this backfill was reverted. reverted_at:, + # The status of the backfill. status:, timeframe_end:, timeframe_start:, + # A boolean + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate deprecation_filter: nil ); end sig do @@ -106,8 +119,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillFetchResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillFetchResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PENDING = T.let(:pending, Orb::Models::Events::BackfillFetchResponse::Status::TaggedSymbol) REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillFetchResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/events/backfill_list_params.rbi b/rbi/lib/orb/models/events/backfill_list_params.rbi index bb252b75..e49befbe 100644 --- a/rbi/lib/orb/models/events/backfill_list_params.rbi +++ b/rbi/lib/orb/models/events/backfill_list_params.rbi @@ -27,8 +27,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}); end - + def self.new( + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. + cursor: nil, + # The number of items to fetch. Defaults to 20. + limit: nil, + request_options: {} + ); end sig do override.returns({cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOptions}) end diff --git a/rbi/lib/orb/models/events/backfill_list_response.rbi b/rbi/lib/orb/models/events/backfill_list_response.rbi index bfc3cea9..41b85b48 100644 --- a/rbi/lib/orb/models/events/backfill_list_response.rbi +++ b/rbi/lib/orb/models/events/backfill_list_response.rbi @@ -70,15 +70,28 @@ module Orb end def self.new( id:, + # If in the future, the time at which the backfill will automatically close. If in + # the past, the time at which the backfill was closed. close_time:, created_at:, + # The Orb-generated ID of the customer to which this backfill is scoped. If + # `null`, this backfill is scoped to all customers. customer_id:, + # The number of events ingested in this backfill. events_ingested:, + # If `true`, existing events in the backfill's timeframe will be replaced with the + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. replace_existing_events:, + # The time at which this backfill was reverted. reverted_at:, + # The status of the backfill. status:, timeframe_end:, timeframe_start:, + # A boolean + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate deprecation_filter: nil ); end sig do @@ -106,8 +119,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillListResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillListResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PENDING = T.let(:pending, Orb::Models::Events::BackfillListResponse::Status::TaggedSymbol) REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillListResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/events/backfill_revert_response.rbi b/rbi/lib/orb/models/events/backfill_revert_response.rbi index 0147cdd7..17e46bdd 100644 --- a/rbi/lib/orb/models/events/backfill_revert_response.rbi +++ b/rbi/lib/orb/models/events/backfill_revert_response.rbi @@ -70,15 +70,28 @@ module Orb end def self.new( id:, + # If in the future, the time at which the backfill will automatically close. If in + # the past, the time at which the backfill was closed. close_time:, created_at:, + # The Orb-generated ID of the customer to which this backfill is scoped. If + # `null`, this backfill is scoped to all customers. customer_id:, + # The number of events ingested in this backfill. events_ingested:, + # If `true`, existing events in the backfill's timeframe will be replaced with the + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. replace_existing_events:, + # The time at which this backfill was reverted. reverted_at:, + # The status of the backfill. status:, timeframe_end:, timeframe_start:, + # A boolean + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate deprecation_filter: nil ); end sig do @@ -106,8 +119,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillRevertResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillRevertResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PENDING = T.let(:pending, Orb::Models::Events::BackfillRevertResponse::Status::TaggedSymbol) REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillRevertResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/events/event_volumes.rbi b/rbi/lib/orb/models/events/event_volumes.rbi index fda18975..f1141d4d 100644 --- a/rbi/lib/orb/models/events/event_volumes.rbi +++ b/rbi/lib/orb/models/events/event_volumes.rbi @@ -30,8 +30,12 @@ module Orb # An EventVolume contains the event volume ingested in an hourly window. The # timestamp used for the aggregation is the `timestamp` datetime field on events. sig { params(count: Integer, timeframe_end: Time, timeframe_start: Time).returns(T.attached_class) } - def self.new(count:, timeframe_end:, timeframe_start:); end - + def self.new( + # The number of events ingested with a timestamp between the timeframe + count:, + timeframe_end:, + timeframe_start: + ); end sig { override.returns({count: Integer, timeframe_end: Time, timeframe_start: Time}) } def to_hash; end end diff --git a/rbi/lib/orb/models/events/volume_list_params.rbi b/rbi/lib/orb/models/events/volume_list_params.rbi index 068a8848..df7fec4d 100644 --- a/rbi/lib/orb/models/events/volume_list_params.rbi +++ b/rbi/lib/orb/models/events/volume_list_params.rbi @@ -46,8 +46,24 @@ module Orb ) .returns(T.attached_class) end - def self.new(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {}); end - + def self.new( + # The start of the timeframe, inclusive, in which to return event volume. All + # datetime values are converted to UTC time. If the specified time isn't + # hour-aligned, the response includes the event volume count for the hour the time + # falls in. + timeframe_start:, + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. + cursor: nil, + # The number of items to fetch. Defaults to 20. + limit: nil, + # The end of the timeframe, exclusive, in which to return event volume. If not + # specified, the current time is used. All datetime values are converted to UTC + # time.If the specified time isn't hour-aligned, the response includes the event + # volumecount for the hour the time falls in. + timeframe_end: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/invoice.rbi b/rbi/lib/orb/models/invoice.rbi index 17e01352..c88efb4b 100644 --- a/rbi/lib/orb/models/invoice.rbi +++ b/rbi/lib/orb/models/invoice.rbi @@ -376,45 +376,199 @@ module Orb end def self.new( id:, + # This is the final amount required to be charged to the customer and reflects the + # application of the customer balance to the `total` of the invoice. amount_due:, auto_collection:, billing_address:, + # The creation time of the resource in Orb. created_at:, + # A list of credit notes associated with the invoice credit_notes:, + # An ISO 4217 currency string or `credits` currency:, customer:, customer_balance_transactions:, + # Tax IDs are commonly required to be displayed on customer invoices, which are + # added to the headers of invoices. + # + # ### Supported Tax ID Countries and Types + # + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | customer_tax_id:, + # This field is deprecated in favor of `discounts`. If a `discounts` list is + # provided, the first discount in the list will be returned. If the list is empty, + # `None` will be returned. discount:, discounts:, + # When the invoice payment is due. The due date is null if the invoice is not yet + # finalized. due_date:, + # If the invoice has a status of `draft`, this will be the time that the invoice + # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is + # true, the invoice will automatically begin issuing at this time. eligible_to_issue_at:, + # A URL for the customer-facing invoice portal. This URL expires 30 days after the + # invoice's due date, or 60 days after being re-generated through the UI. hosted_invoice_url:, + # The scheduled date of the invoice invoice_date:, + # Automatically generated invoice number to help track and reconcile invoices. + # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per + # account or customer. invoice_number:, + # The link to download the PDF representation of the `Invoice`. invoice_pdf:, invoice_source:, + # If the invoice failed to issue, this will be the last time it failed to issue + # (even if it is now in a different state.) issue_failed_at:, + # If the invoice has been issued, this will be the time it transitioned to + # `issued` (even if it is now in a different state.) issued_at:, + # The breakdown of prices in this invoice. line_items:, maximum:, maximum_amount:, + # Free-form text which is available on the invoice PDF and the Orb invoice portal. memo:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, + # If the invoice has a status of `paid`, this gives a timestamp when the invoice + # was paid. paid_at:, + # A list of payment attempts associated with the invoice payment_attempts:, + # If payment was attempted on this invoice but failed, this will be the time of + # the most recent attempt. payment_failed_at:, + # If payment was attempted on this invoice, this will be the start time of the + # most recent attempt. This field is especially useful for delayed-notification + # payment mechanisms (like bank transfers), where payment can take 3 days or more. payment_started_at:, + # If the invoice is in draft, this timestamp will reflect when the invoice is + # scheduled to be issued. scheduled_issue_at:, shipping_address:, status:, subscription:, + # The total before any discounts and minimums are applied. subtotal:, + # If the invoice failed to sync, this will be the last time an external invoicing + # provider sync was attempted. This field will always be `null` for invoices using + # Orb Invoicing. sync_failed_at:, + # The total after any minimums and discounts have been applied. total:, + # If the invoice has a status of `void`, this gives a timestamp when the invoice + # was voided. voided_at:, + # This is true if the invoice will be automatically issued in the future, and + # false otherwise. will_auto_issue: ); end sig do @@ -500,8 +654,23 @@ module Orb ) .returns(T.attached_class) end - def self.new(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:); end - + def self.new( + # True only if auto-collection is enabled for this invoice. + enabled:, + # If the invoice is scheduled for auto-collection, this field will reflect when + # the next attempt will occur. If dunning has been exhausted, or auto-collection + # is not enabled for this invoice, this field will be `null`. + next_attempt_at:, + # Number of auto-collection payment attempts. + num_attempts:, + # If Orb has ever attempted payment auto-collection for this invoice, this field + # will reflect when that attempt occurred. In conjunction with `next_attempt_at`, + # this can be used to tell whether the invoice is currently in dunning (that is, + # `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or + # if dunning has been exhausted (`previously_attempted_at` is non-null, but + # `next_attempt_time` is null). + previously_attempted_at: + ); end sig do override .returns( @@ -601,8 +770,18 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:); end - + def self.new( + id:, + credit_note_number:, + # An optional memo supplied on the credit note. + memo:, + reason:, + total:, + type:, + # If the credit note has a status of `void`, this gives a timestamp when the + # credit note was voided. + voided_at: + ); end sig do override .returns( @@ -705,14 +884,22 @@ module Orb .returns(T.attached_class) end def self.new( + # A unique id for this transaction. id:, action:, + # The value of the amount changed in the transaction. amount:, + # The creation time of this transaction. created_at:, credit_note:, + # An optional description provided for manual customer balance adjustments. description:, + # The new value of the customer's balance prior to the transaction, in the + # customer's currency. ending_balance:, invoice:, + # The original value of the customer's balance prior to the transaction, in the + # customer's currency. starting_balance:, type: ); end @@ -739,8 +926,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Action) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } APPLIED_TO_INVOICE = T.let(:applied_to_invoice, Orb::Models::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol) @@ -771,8 +957,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:); end - + def self.new( + # The id of the Credit note + id: + ); end sig { override.returns({id: String}) } def to_hash; end end @@ -783,8 +971,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:); end - + def self.new( + # The Invoice id + id: + ); end sig { override.returns({id: String}) } def to_hash; end end @@ -793,8 +983,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INCREMENT = T.let(:increment, Orb::Models::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol) DECREMENT = T.let(:decrement, Orb::Models::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol) @@ -945,8 +1134,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Invoice::CustomerTaxID::Country) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Invoice::CustomerTaxID::Country::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } AD = T.let(:AD, Orb::Models::Invoice::CustomerTaxID::Country::TaggedSymbol) AE = T.let(:AE, Orb::Models::Invoice::CustomerTaxID::Country::TaggedSymbol) @@ -1035,8 +1223,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Invoice::CustomerTaxID::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Invoice::CustomerTaxID::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } AD_NRT = T.let(:ad_nrt, Orb::Models::Invoice::CustomerTaxID::Type::TaggedSymbol) AE_TRN = T.let(:ae_trn, Orb::Models::Invoice::CustomerTaxID::Type::TaggedSymbol) @@ -1119,7 +1306,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Invoice::InvoiceSource) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Invoice::InvoiceSource::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } SUBSCRIPTION = T.let(:subscription, Orb::Models::Invoice::InvoiceSource::TaggedSymbol) PARTIAL = T.let(:partial, Orb::Models::Invoice::InvoiceSource::TaggedSymbol) @@ -1392,27 +1579,65 @@ module Orb .returns(T.attached_class) end def self.new( + # A unique ID for this line item. id:, + # The line amount after any adjustments and before overage conversion, credits and + # partial invoicing. adjusted_subtotal:, + # All adjustments applied to the line item in the order they were applied based on + # invoice calculations (ie. usage discounts -> amount discounts -> percentage + # discounts -> minimums -> maximums). adjustments:, + # The final amount for a line item after all adjustments and pre paid credits have + # been applied. amount:, + # The number of prepaid credits applied. credits_applied:, discount:, + # The end date of the range of time applied for this line item's price. end_date:, + # An additional filter that was used to calculate the usage for this line item. filter:, + # [DEPRECATED] For configured prices that are split by a grouping key, this will + # be populated with the key and a value. The `amount` and `subtotal` will be the + # values for this particular grouping. grouping:, + # This field is deprecated in favor of `adjustments`. maximum:, + # This field is deprecated in favor of `adjustments`. maximum_amount:, + # This field is deprecated in favor of `adjustments`. minimum:, + # This field is deprecated in favor of `adjustments`. minimum_amount:, + # The name of the price associated with this line item. name:, + # Any amount applied from a partial invoice partially_invoiced_amount:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # Either the fixed fee quantity or the usage during the service period. quantity:, + # The start date of the range of time applied for this line item's price. start_date:, + # For complex pricing structures, the line item can be broken down further in + # `sub_line_items`. sub_line_items:, + # The line amount before before any adjustments. subtotal:, + # An array of tax rates and their incurred tax amounts. Empty if no tax + # integration is configured. tax_amounts:, + # A list of customer ids that were used to calculate the usage for this line item. usage_customer_ids: ); end sig do @@ -1544,10 +1769,17 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -1611,10 +1843,17 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -1678,10 +1917,17 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -1750,11 +1996,19 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -1819,10 +2073,17 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -1866,8 +2127,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -1886,8 +2152,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -1952,8 +2223,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix); end - + def self.new( + # The total amount for this sub line item. + amount:, + grouping:, + matrix_config:, + name:, + quantity:, + type: :matrix + ); end sig do override .returns( @@ -1978,8 +2256,11 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:); end - + def self.new( + key:, + # No value indicates the default group + value: + ); end sig { override.returns({key: String, value: T.nilable(String)}) } def to_hash; end end @@ -1990,8 +2271,10 @@ module Orb attr_accessor :dimension_values sig { params(dimension_values: T::Array[T.nilable(String)]).returns(T.attached_class) } - def self.new(dimension_values:); end - + def self.new( + # The ordered dimension values for this line item. + dimension_values: + ); end sig { override.returns({dimension_values: T::Array[T.nilable(String)]}) } def to_hash; end end @@ -2048,8 +2331,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier); end - + def self.new( + # The total amount for this sub line item. + amount:, + grouping:, + name:, + quantity:, + tier_config:, + type: :tier + ); end sig do override .returns( @@ -2074,8 +2364,11 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:); end - + def self.new( + key:, + # No value indicates the default group + value: + ); end sig { override.returns({key: String, value: T.nilable(String)}) } def to_hash; end end @@ -2143,8 +2436,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, name:, quantity:, type: :"'null'"); end - + def self.new( + # The total amount for this sub line item. + amount:, + grouping:, + name:, + quantity:, + type: :"'null'" + ); end sig do override .returns( @@ -2168,8 +2467,11 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:); end - + def self.new( + key:, + # No value indicates the default group + value: + ); end sig { override.returns({key: String, value: T.nilable(String)}) } def to_hash; end end @@ -2201,8 +2503,14 @@ module Orb params(amount: String, tax_rate_description: String, tax_rate_percentage: T.nilable(String)) .returns(T.attached_class) end - def self.new(amount:, tax_rate_description:, tax_rate_percentage:); end - + def self.new( + # The amount of additional tax incurred by this tax rate. + amount:, + # The human-readable description of the applied tax rate. + tax_rate_description:, + # The tax rate percentage, out of 100. + tax_rate_percentage: + ); end sig do override.returns( { @@ -2229,8 +2537,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -2248,8 +2561,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -2290,8 +2608,20 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:); end - + def self.new( + # The ID of the payment attempt. + id:, + # The amount of the payment attempt. + amount:, + # The time at which the payment attempt was created. + created_at:, + # The payment provider that attempted to collect the payment. + payment_provider:, + # The ID of the payment attempt in the payment provider. + payment_provider_id:, + # Whether the payment attempt succeeded. + succeeded: + ); end sig do override .returns( @@ -2312,8 +2642,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Invoice::PaymentAttempt::PaymentProvider) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } STRIPE = T.let(:stripe, Orb::Models::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol) @@ -2374,7 +2703,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Invoice::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Invoice::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ISSUED = T.let(:issued, Orb::Models::Invoice::Status::TaggedSymbol) PAID = T.let(:paid, Orb::Models::Invoice::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/invoice_create_params.rbi b/rbi/lib/orb/models/invoice_create_params.rbi index d8ded73a..ac510986 100644 --- a/rbi/lib/orb/models/invoice_create_params.rbi +++ b/rbi/lib/orb/models/invoice_create_params.rbi @@ -95,15 +95,35 @@ module Orb .returns(T.attached_class) end def self.new( + # An ISO 4217 currency string. Must be the same as the customer's currency if it + # is set. currency:, + # Optional invoice date to set. Must be in the past, if not set, `invoice_date` is + # set to the current time in the customer's timezone. invoice_date:, line_items:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of '0' here represents that the + # invoice is due on issue, whereas a value of 30 represents that the customer has + # 30 days to pay the invoice. net_terms:, + # The id of the `Customer` to create this invoice for. One of `customer_id` and + # `external_customer_id` are required. customer_id: nil, + # An optional discount to attach to the invoice. discount: nil, + # The `external_customer_id` of the `Customer` to create this invoice for. One of + # `customer_id` and `external_customer_id` are required. external_customer_id: nil, + # An optional memo to attach to the invoice. memo: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # When true, this invoice will be submitted for issuance upon creation. When + # false, the resulting invoice will require manual review to issue. Defaulted to + # false. will_auto_issue: nil, request_options: {} ); end @@ -178,8 +198,19 @@ module Orb ) .returns(T.attached_class) end - def self.new(end_date:, item_id:, model_type:, name:, quantity:, start_date:, unit_config:); end - + def self.new( + # A date string to specify the line item's end date in the customer's timezone. + end_date:, + item_id:, + model_type:, + # The name of the line item. + name:, + # The number of units on the line item + quantity:, + # A date string to specify the line item's start date in the customer's timezone. + start_date:, + unit_config: + ); end sig do override .returns( @@ -200,8 +231,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceCreateParams::LineItem::ModelType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceCreateParams::LineItem::ModelType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } UNIT = T.let(:unit, Orb::Models::InvoiceCreateParams::LineItem::ModelType::TaggedSymbol) @@ -215,8 +245,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:); end - + def self.new( + # Rate per unit of usage + unit_amount: + ); end sig { override.returns({unit_amount: String}) } def to_hash; end end diff --git a/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi b/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi index ec3924d8..4fda8e96 100644 --- a/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +++ b/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi @@ -398,45 +398,199 @@ module Orb end def self.new( id:, + # This is the final amount required to be charged to the customer and reflects the + # application of the customer balance to the `total` of the invoice. amount_due:, auto_collection:, billing_address:, + # The creation time of the resource in Orb. created_at:, + # A list of credit notes associated with the invoice credit_notes:, + # An ISO 4217 currency string or `credits` currency:, customer:, customer_balance_transactions:, + # Tax IDs are commonly required to be displayed on customer invoices, which are + # added to the headers of invoices. + # + # ### Supported Tax ID Countries and Types + # + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | customer_tax_id:, + # This field is deprecated in favor of `discounts`. If a `discounts` list is + # provided, the first discount in the list will be returned. If the list is empty, + # `None` will be returned. discount:, discounts:, + # When the invoice payment is due. The due date is null if the invoice is not yet + # finalized. due_date:, + # If the invoice has a status of `draft`, this will be the time that the invoice + # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is + # true, the invoice will automatically begin issuing at this time. eligible_to_issue_at:, + # A URL for the customer-facing invoice portal. This URL expires 30 days after the + # invoice's due date, or 60 days after being re-generated through the UI. hosted_invoice_url:, + # Automatically generated invoice number to help track and reconcile invoices. + # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per + # account or customer. invoice_number:, + # The link to download the PDF representation of the `Invoice`. invoice_pdf:, invoice_source:, + # If the invoice failed to issue, this will be the last time it failed to issue + # (even if it is now in a different state.) issue_failed_at:, + # If the invoice has been issued, this will be the time it transitioned to + # `issued` (even if it is now in a different state.) issued_at:, + # The breakdown of prices in this invoice. line_items:, maximum:, maximum_amount:, + # Free-form text which is available on the invoice PDF and the Orb invoice portal. memo:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, + # If the invoice has a status of `paid`, this gives a timestamp when the invoice + # was paid. paid_at:, + # A list of payment attempts associated with the invoice payment_attempts:, + # If payment was attempted on this invoice but failed, this will be the time of + # the most recent attempt. payment_failed_at:, + # If payment was attempted on this invoice, this will be the start time of the + # most recent attempt. This field is especially useful for delayed-notification + # payment mechanisms (like bank transfers), where payment can take 3 days or more. payment_started_at:, + # If the invoice is in draft, this timestamp will reflect when the invoice is + # scheduled to be issued. scheduled_issue_at:, shipping_address:, status:, subscription:, + # The total before any discounts and minimums are applied. subtotal:, + # If the invoice failed to sync, this will be the last time an external invoicing + # provider sync was attempted. This field will always be `null` for invoices using + # Orb Invoicing. sync_failed_at:, + # The scheduled date of the invoice target_date:, + # The total after any minimums and discounts have been applied. total:, + # If the invoice has a status of `void`, this gives a timestamp when the invoice + # was voided. voided_at:, + # This is true if the invoice will be automatically issued in the future, and + # false otherwise. will_auto_issue: ); end sig do @@ -522,8 +676,23 @@ module Orb ) .returns(T.attached_class) end - def self.new(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:); end - + def self.new( + # True only if auto-collection is enabled for this invoice. + enabled:, + # If the invoice is scheduled for auto-collection, this field will reflect when + # the next attempt will occur. If dunning has been exhausted, or auto-collection + # is not enabled for this invoice, this field will be `null`. + next_attempt_at:, + # Number of auto-collection payment attempts. + num_attempts:, + # If Orb has ever attempted payment auto-collection for this invoice, this field + # will reflect when that attempt occurred. In conjunction with `next_attempt_at`, + # this can be used to tell whether the invoice is currently in dunning (that is, + # `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or + # if dunning has been exhausted (`previously_attempted_at` is non-null, but + # `next_attempt_time` is null). + previously_attempted_at: + ); end sig do override .returns( @@ -623,8 +792,18 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:); end - + def self.new( + id:, + credit_note_number:, + # An optional memo supplied on the credit note. + memo:, + reason:, + total:, + type:, + # If the credit note has a status of `void`, this gives a timestamp when the + # credit note was voided. + voided_at: + ); end sig do override .returns( @@ -747,14 +926,22 @@ module Orb .returns(T.attached_class) end def self.new( + # A unique id for this transaction. id:, action:, + # The value of the amount changed in the transaction. amount:, + # The creation time of this transaction. created_at:, credit_note:, + # An optional description provided for manual customer balance adjustments. description:, + # The new value of the customer's balance prior to the transaction, in the + # customer's currency. ending_balance:, invoice:, + # The original value of the customer's balance prior to the transaction, in the + # customer's currency. starting_balance:, type: ); end @@ -782,14 +969,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } APPLIED_TO_INVOICE = T.let( @@ -852,8 +1032,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:); end - + def self.new( + # The id of the Credit note + id: + ); end sig { override.returns({id: String}) } def to_hash; end end @@ -864,8 +1046,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:); end - + def self.new( + # The Invoice id + id: + ); end sig { override.returns({id: String}) } def to_hash; end end @@ -875,14 +1059,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } INCREMENT = T.let( @@ -1047,8 +1224,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } AD = T.let(:AD, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country::TaggedSymbol) AE = T.let(:AE, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country::TaggedSymbol) @@ -1140,8 +1316,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } AD_NRT = T.let(:ad_nrt, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type::TaggedSymbol) AE_TRN = T.let(:ae_trn, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type::TaggedSymbol) @@ -1229,8 +1404,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } SUBSCRIPTION = T.let(:subscription, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource::TaggedSymbol) @@ -1514,27 +1688,65 @@ module Orb .returns(T.attached_class) end def self.new( + # A unique ID for this line item. id:, + # The line amount after any adjustments and before overage conversion, credits and + # partial invoicing. adjusted_subtotal:, + # All adjustments applied to the line item in the order they were applied based on + # invoice calculations (ie. usage discounts -> amount discounts -> percentage + # discounts -> minimums -> maximums). adjustments:, + # The final amount for a line item after all adjustments and pre paid credits have + # been applied. amount:, + # The number of prepaid credits applied. credits_applied:, discount:, + # The end date of the range of time applied for this line item's price. end_date:, + # An additional filter that was used to calculate the usage for this line item. filter:, + # [DEPRECATED] For configured prices that are split by a grouping key, this will + # be populated with the key and a value. The `amount` and `subtotal` will be the + # values for this particular grouping. grouping:, + # This field is deprecated in favor of `adjustments`. maximum:, + # This field is deprecated in favor of `adjustments`. maximum_amount:, + # This field is deprecated in favor of `adjustments`. minimum:, + # This field is deprecated in favor of `adjustments`. minimum_amount:, + # The name of the price associated with this line item. name:, + # Any amount applied from a partial invoice partially_invoiced_amount:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # Either the fixed fee quantity or the usage during the service period. quantity:, + # The start date of the range of time applied for this line item's price. start_date:, + # For complex pricing structures, the line item can be broken down further in + # `sub_line_items`. sub_line_items:, + # The line amount before before any adjustments. subtotal:, + # An array of tax rates and their incurred tax amounts. Empty if no tax + # integration is configured. tax_amounts:, + # A list of customer ids that were used to calculate the usage for this line item. usage_customer_ids: ); end sig do @@ -1666,10 +1878,17 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -1733,10 +1952,17 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -1800,10 +2026,17 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -1872,11 +2105,19 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -1941,10 +2182,17 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -1988,8 +2236,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -2008,8 +2261,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -2084,8 +2342,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix); end - + def self.new( + # The total amount for this sub line item. + amount:, + grouping:, + matrix_config:, + name:, + quantity:, + type: :matrix + ); end sig do override .returns( @@ -2110,8 +2375,11 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:); end - + def self.new( + key:, + # No value indicates the default group + value: + ); end sig { override.returns({key: String, value: T.nilable(String)}) } def to_hash; end end @@ -2122,8 +2390,10 @@ module Orb attr_accessor :dimension_values sig { params(dimension_values: T::Array[T.nilable(String)]).returns(T.attached_class) } - def self.new(dimension_values:); end - + def self.new( + # The ordered dimension values for this line item. + dimension_values: + ); end sig { override.returns({dimension_values: T::Array[T.nilable(String)]}) } def to_hash; end end @@ -2196,8 +2466,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier); end - + def self.new( + # The total amount for this sub line item. + amount:, + grouping:, + name:, + quantity:, + tier_config:, + type: :tier + ); end sig do override .returns( @@ -2222,8 +2499,11 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:); end - + def self.new( + key:, + # No value indicates the default group + value: + ); end sig { override.returns({key: String, value: T.nilable(String)}) } def to_hash; end end @@ -2301,8 +2581,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, name:, quantity:, type: :"'null'"); end - + def self.new( + # The total amount for this sub line item. + amount:, + grouping:, + name:, + quantity:, + type: :"'null'" + ); end sig do override .returns( @@ -2326,8 +2612,11 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:); end - + def self.new( + key:, + # No value indicates the default group + value: + ); end sig { override.returns({key: String, value: T.nilable(String)}) } def to_hash; end end @@ -2359,8 +2648,14 @@ module Orb params(amount: String, tax_rate_description: String, tax_rate_percentage: T.nilable(String)) .returns(T.attached_class) end - def self.new(amount:, tax_rate_description:, tax_rate_percentage:); end - + def self.new( + # The amount of additional tax incurred by this tax rate. + amount:, + # The human-readable description of the applied tax rate. + tax_rate_description:, + # The tax rate percentage, out of 100. + tax_rate_percentage: + ); end sig do override.returns( { @@ -2387,8 +2682,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -2406,8 +2706,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -2452,8 +2757,20 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:); end - + def self.new( + # The ID of the payment attempt. + id:, + # The amount of the payment attempt. + amount:, + # The time at which the payment attempt was created. + created_at:, + # The payment provider that attempted to collect the payment. + payment_provider:, + # The ID of the payment attempt in the payment provider. + payment_provider_id:, + # Whether the payment attempt succeeded. + succeeded: + ); end sig do override .returns( @@ -2475,14 +2792,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } STRIPE = T.let(:stripe, Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider::TaggedSymbol) @@ -2549,8 +2859,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ISSUED = T.let(:issued, Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol) PAID = T.let(:paid, Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/invoice_issue_params.rbi b/rbi/lib/orb/models/invoice_issue_params.rbi index 9e113657..5ff7b672 100644 --- a/rbi/lib/orb/models/invoice_issue_params.rbi +++ b/rbi/lib/orb/models/invoice_issue_params.rbi @@ -21,8 +21,15 @@ module Orb params(synchronous: T::Boolean, request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)) .returns(T.attached_class) end - def self.new(synchronous: nil, request_options: {}); end - + def self.new( + # If true, the invoice will be issued synchronously. If false, the invoice will be + # issued asynchronously. The synchronous option is only available for invoices + # that have no usage fees. If the invoice is configured to sync to an external + # provider, a successful response from this endpoint guarantees the invoice is + # present in the provider. + synchronous: nil, + request_options: {} + ); end sig { override.returns({synchronous: T::Boolean, request_options: Orb::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/orb/models/invoice_line_item_create_params.rbi b/rbi/lib/orb/models/invoice_line_item_create_params.rbi index dce846e9..4af81424 100644 --- a/rbi/lib/orb/models/invoice_line_item_create_params.rbi +++ b/rbi/lib/orb/models/invoice_line_item_create_params.rbi @@ -43,8 +43,22 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, end_date:, invoice_id:, name:, quantity:, start_date:, request_options: {}); end - + def self.new( + # The total amount in the invoice's currency to add to the line item. + amount:, + # A date string to specify the line item's end date in the customer's timezone. + end_date:, + # The id of the Invoice to add this line item. + invoice_id:, + # The item name associated with this line item. If an item with the same name + # exists in Orb, that item will be associated with the line item. + name:, + # The number of units on the line item + quantity:, + # A date string to specify the line item's start date in the customer's timezone. + start_date:, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/invoice_line_item_create_response.rbi b/rbi/lib/orb/models/invoice_line_item_create_response.rbi index 770bfc72..4e3ea380 100644 --- a/rbi/lib/orb/models/invoice_line_item_create_response.rbi +++ b/rbi/lib/orb/models/invoice_line_item_create_response.rbi @@ -275,27 +275,65 @@ module Orb .returns(T.attached_class) end def self.new( + # A unique ID for this line item. id:, + # The line amount after any adjustments and before overage conversion, credits and + # partial invoicing. adjusted_subtotal:, + # All adjustments applied to the line item in the order they were applied based on + # invoice calculations (ie. usage discounts -> amount discounts -> percentage + # discounts -> minimums -> maximums). adjustments:, + # The final amount for a line item after all adjustments and pre paid credits have + # been applied. amount:, + # The number of prepaid credits applied. credits_applied:, discount:, + # The end date of the range of time applied for this line item's price. end_date:, + # An additional filter that was used to calculate the usage for this line item. filter:, + # [DEPRECATED] For configured prices that are split by a grouping key, this will + # be populated with the key and a value. The `amount` and `subtotal` will be the + # values for this particular grouping. grouping:, + # This field is deprecated in favor of `adjustments`. maximum:, + # This field is deprecated in favor of `adjustments`. maximum_amount:, + # This field is deprecated in favor of `adjustments`. minimum:, + # This field is deprecated in favor of `adjustments`. minimum_amount:, + # The name of the price associated with this line item. name:, + # Any amount applied from a partial invoice partially_invoiced_amount:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # Either the fixed fee quantity or the usage during the service period. quantity:, + # The start date of the range of time applied for this line item's price. start_date:, + # For complex pricing structures, the line item can be broken down further in + # `sub_line_items`. sub_line_items:, + # The line amount before before any adjustments. subtotal:, + # An array of tax rates and their incurred tax amounts. Empty if no tax + # integration is configured. tax_amounts:, + # A list of customer ids that were used to calculate the usage for this line item. usage_customer_ids: ); end sig do @@ -427,10 +465,17 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -494,10 +539,17 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -561,10 +613,17 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -633,11 +692,19 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -702,10 +769,17 @@ module Orb end def self.new( id:, + # The value applied by an adjustment. amount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -749,8 +823,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -769,8 +848,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -841,8 +925,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix); end - + def self.new( + # The total amount for this sub line item. + amount:, + grouping:, + matrix_config:, + name:, + quantity:, + type: :matrix + ); end sig do override .returns( @@ -867,8 +958,11 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:); end - + def self.new( + key:, + # No value indicates the default group + value: + ); end sig { override.returns({key: String, value: T.nilable(String)}) } def to_hash; end end @@ -879,8 +973,10 @@ module Orb attr_accessor :dimension_values sig { params(dimension_values: T::Array[T.nilable(String)]).returns(T.attached_class) } - def self.new(dimension_values:); end - + def self.new( + # The ordered dimension values for this line item. + dimension_values: + ); end sig { override.returns({dimension_values: T::Array[T.nilable(String)]}) } def to_hash; end end @@ -949,8 +1045,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier); end - + def self.new( + # The total amount for this sub line item. + amount:, + grouping:, + name:, + quantity:, + tier_config:, + type: :tier + ); end sig do override .returns( @@ -975,8 +1078,11 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:); end - + def self.new( + key:, + # No value indicates the default group + value: + ); end sig { override.returns({key: String, value: T.nilable(String)}) } def to_hash; end end @@ -1050,8 +1156,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, name:, quantity:, type: :"'null'"); end - + def self.new( + # The total amount for this sub line item. + amount:, + grouping:, + name:, + quantity:, + type: :"'null'" + ); end sig do override .returns( @@ -1075,8 +1187,11 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:); end - + def self.new( + key:, + # No value indicates the default group + value: + ); end sig { override.returns({key: String, value: T.nilable(String)}) } def to_hash; end end @@ -1108,8 +1223,14 @@ module Orb params(amount: String, tax_rate_description: String, tax_rate_percentage: T.nilable(String)) .returns(T.attached_class) end - def self.new(amount:, tax_rate_description:, tax_rate_percentage:); end - + def self.new( + # The amount of additional tax incurred by this tax rate. + amount:, + # The human-readable description of the applied tax rate. + tax_rate_description:, + # The tax rate percentage, out of 100. + tax_rate_percentage: + ); end sig do override.returns( { diff --git a/rbi/lib/orb/models/invoice_list_params.rbi b/rbi/lib/orb/models/invoice_list_params.rbi index 843d1d0c..b4cbb4a1 100644 --- a/rbi/lib/orb/models/invoice_list_params.rbi +++ b/rbi/lib/orb/models/invoice_list_params.rbi @@ -102,10 +102,16 @@ module Orb amount: nil, amount_gt: nil, amount_lt: nil, + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. cursor: nil, customer_id: nil, date_type: nil, due_date: nil, + # Filters invoices by their due dates within a specific time range in the past. + # Specify the range as a number followed by 'd' (days) or 'm' (months). For + # example, '7d' filters invoices due in the last 7 days, and '2m' filters those + # due in the last 2 months. due_date_window: nil, due_date_gt: nil, due_date_lt: nil, @@ -115,6 +121,7 @@ module Orb invoice_date_lt: nil, invoice_date_lte: nil, is_recurring: nil, + # The number of items to fetch. Defaults to 20. limit: nil, status: nil, subscription_id: nil, @@ -153,7 +160,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceListParams::DateType) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceListParams::DateType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } DUE_DATE = T.let(:due_date, Orb::Models::InvoiceListParams::DateType::TaggedSymbol) INVOICE_DATE = T.let(:invoice_date, Orb::Models::InvoiceListParams::DateType::TaggedSymbol) @@ -166,7 +173,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceListParams::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceListParams::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } DRAFT = T.let(:draft, Orb::Models::InvoiceListParams::Status::TaggedSymbol) ISSUED = T.let(:issued, Orb::Models::InvoiceListParams::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/invoice_mark_paid_params.rbi b/rbi/lib/orb/models/invoice_mark_paid_params.rbi index 207edef4..db2b9226 100644 --- a/rbi/lib/orb/models/invoice_mark_paid_params.rbi +++ b/rbi/lib/orb/models/invoice_mark_paid_params.rbi @@ -27,8 +27,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(payment_received_date:, external_id: nil, notes: nil, request_options: {}); end - + def self.new( + # A date string to specify the date of the payment. + payment_received_date:, + # An optional external ID to associate with the payment. + external_id: nil, + # An optional note to associate with the payment. + notes: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/invoice_update_params.rbi b/rbi/lib/orb/models/invoice_update_params.rbi index b14cca36..e5af4e83 100644 --- a/rbi/lib/orb/models/invoice_update_params.rbi +++ b/rbi/lib/orb/models/invoice_update_params.rbi @@ -19,8 +19,13 @@ module Orb ) .returns(T.attached_class) end - def self.new(metadata: nil, request_options: {}); end - + def self.new( + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. + metadata: nil, + request_options: {} + ); end sig do override .returns({ diff --git a/rbi/lib/orb/models/item.rbi b/rbi/lib/orb/models/item.rbi index a245f107..4d74d845 100644 --- a/rbi/lib/orb/models/item.rbi +++ b/rbi/lib/orb/models/item.rbi @@ -74,8 +74,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } STRIPE = T.let(:stripe, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol) QUICKBOOKS = diff --git a/rbi/lib/orb/models/item_create_params.rbi b/rbi/lib/orb/models/item_create_params.rbi index ed4fec95..6aa353f9 100644 --- a/rbi/lib/orb/models/item_create_params.rbi +++ b/rbi/lib/orb/models/item_create_params.rbi @@ -14,8 +14,11 @@ module Orb params(name: String, request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)) .returns(T.attached_class) end - def self.new(name:, request_options: {}); end - + def self.new( + # The name of the item. + name:, + request_options: {} + ); end sig { override.returns({name: String, request_options: Orb::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/orb/models/item_list_params.rbi b/rbi/lib/orb/models/item_list_params.rbi index 72042447..b7bcf459 100644 --- a/rbi/lib/orb/models/item_list_params.rbi +++ b/rbi/lib/orb/models/item_list_params.rbi @@ -26,8 +26,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}); end - + def self.new( + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. + cursor: nil, + # The number of items to fetch. Defaults to 20. + limit: nil, + request_options: {} + ); end sig do override.returns({cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOptions}) end diff --git a/rbi/lib/orb/models/item_update_params.rbi b/rbi/lib/orb/models/item_update_params.rbi index 4daba38a..3a191ad0 100644 --- a/rbi/lib/orb/models/item_update_params.rbi +++ b/rbi/lib/orb/models/item_update_params.rbi @@ -66,14 +66,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } STRIPE = T.let(:stripe, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol) diff --git a/rbi/lib/orb/models/metric_create_params.rbi b/rbi/lib/orb/models/metric_create_params.rbi index b8fb5180..7cc40ee1 100644 --- a/rbi/lib/orb/models/metric_create_params.rbi +++ b/rbi/lib/orb/models/metric_create_params.rbi @@ -39,8 +39,21 @@ module Orb ) .returns(T.attached_class) end - def self.new(description:, item_id:, name:, sql:, metadata: nil, request_options: {}); end - + def self.new( + # A description of the metric. + description:, + # The id of the item + item_id:, + # The name of the metric. + name:, + # A sql string defining the metric. + sql:, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. + metadata: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/metric_list_params.rbi b/rbi/lib/orb/models/metric_list_params.rbi index fe639eed..93fb394e 100644 --- a/rbi/lib/orb/models/metric_list_params.rbi +++ b/rbi/lib/orb/models/metric_list_params.rbi @@ -47,7 +47,10 @@ module Orb created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. cursor: nil, + # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} ); end diff --git a/rbi/lib/orb/models/metric_update_params.rbi b/rbi/lib/orb/models/metric_update_params.rbi index aeb30a6e..384e56da 100644 --- a/rbi/lib/orb/models/metric_update_params.rbi +++ b/rbi/lib/orb/models/metric_update_params.rbi @@ -19,8 +19,13 @@ module Orb ) .returns(T.attached_class) end - def self.new(metadata: nil, request_options: {}); end - + def self.new( + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. + metadata: nil, + request_options: {} + ); end sig do override .returns({ diff --git a/rbi/lib/orb/models/percentage_discount.rbi b/rbi/lib/orb/models/percentage_discount.rbi index d7440f9c..494a6ef4 100644 --- a/rbi/lib/orb/models/percentage_discount.rbi +++ b/rbi/lib/orb/models/percentage_discount.rbi @@ -28,8 +28,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(applies_to_price_ids:, discount_type:, percentage_discount:, reason: nil); end - + def self.new( + # List of price_ids that this discount applies to. For plan/plan phase discounts, + # this can be a subset of prices. + applies_to_price_ids:, + discount_type:, + # Only available if discount_type is `percentage`. This is a number between 0 + # and 1. + percentage_discount:, + reason: nil + ); end sig do override .returns( @@ -47,8 +55,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PercentageDiscount::DiscountType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::PercentageDiscount::DiscountType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PERCENTAGE = T.let(:percentage, Orb::Models::PercentageDiscount::DiscountType::TaggedSymbol) diff --git a/rbi/lib/orb/models/plan.rbi b/rbi/lib/orb/models/plan.rbi index a03c051b..10c2076a 100644 --- a/rbi/lib/orb/models/plan.rbi +++ b/rbi/lib/orb/models/plan.rbi @@ -256,24 +256,48 @@ module Orb end def self.new( id:, + # Adjustments for this plan. If the plan has phases, this includes adjustments + # across all phases of the plan. adjustments:, base_plan:, + # The parent plan id if the given plan was created by overriding one or more of + # the parent's prices base_plan_id:, created_at:, + # An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's + # prices. currency:, + # The default memo text on the invoices corresponding to subscriptions on this + # plan. Note that each subscription may configure its own memo. default_invoice_memo:, description:, discount:, + # An optional user-defined ID for this plan resource, used throughout the system + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. external_plan_id:, + # An ISO 4217 currency string for which this plan is billed in. Matches `currency` + # unless `currency` is a custom pricing unit. invoicing_currency:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, name:, + # Determines the difference between the invoice issue date and the due date. A + # value of "0" here signifies that invoices are due on issue, whereas a value of + # "30" means that the customer has a month to pay the invoice before its overdue. + # Note that individual subscriptions or invoices may set a different net terms + # configuration. net_terms:, plan_phases:, + # Prices for this plan. If the plan has phases, this includes prices across all + # phases of the plan. prices:, product:, status:, @@ -405,10 +429,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -472,10 +503,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -539,10 +577,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -611,11 +656,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -680,10 +733,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -730,8 +790,14 @@ module Orb params(id: T.nilable(String), external_plan_id: T.nilable(String), name: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, external_plan_id:, name:); end - + def self.new( + id:, + # An optional user-defined ID for this plan resource, used throughout the system + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. + external_plan_id:, + name: + ); end sig do override.returns( { @@ -757,8 +823,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -776,8 +847,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -864,6 +940,8 @@ module Orb id:, description:, discount:, + # How many terms of length `duration_unit` this phase is active for. If null, this + # phase is evergreen and active indefinitely duration:, duration_unit:, maximum:, @@ -871,6 +949,7 @@ module Orb minimum:, minimum_amount:, name:, + # Determines the ordering of the phase in a plan's lifecycle. 1 = first phase. order: ); end sig do @@ -904,8 +983,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Plan::PlanPhase::DurationUnit) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } DAILY = T.let(:daily, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol) @@ -930,8 +1008,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -949,8 +1032,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -977,7 +1065,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Plan::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Plan::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::Plan::Status::TaggedSymbol) ARCHIVED = T.let(:archived, Orb::Models::Plan::Status::TaggedSymbol) @@ -1018,8 +1106,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } DAYS = T.let(:days, Orb::Models::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol) diff --git a/rbi/lib/orb/models/plan_create_params.rbi b/rbi/lib/orb/models/plan_create_params.rbi index ec8ea2fa..7d1ea307 100644 --- a/rbi/lib/orb/models/plan_create_params.rbi +++ b/rbi/lib/orb/models/plan_create_params.rbi @@ -122,13 +122,26 @@ module Orb .returns(T.attached_class) end def self.new( + # An ISO 4217 currency string for invoices generated by subscriptions on this + # plan. currency:, name:, + # Prices for this plan. If the plan has phases, this includes prices across all + # phases of the plan. prices:, + # Free-form text which is available on the invoice PDF and the Orb invoice portal. default_invoice_memo: nil, external_plan_id: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # The net terms determines the difference between the invoice date and the issue + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. net_terms: nil, + # The status of the plan to create (either active or draft). If not specified, + # this defaults to active. status: nil, request_options: {} ); end @@ -313,19 +326,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :unit ); end @@ -359,8 +393,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence::TaggedSymbol) SEMI_ANNUAL = @@ -382,8 +415,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:); end - + def self.new( + # Rate per unit of usage + unit_amount: + ); end sig { override.returns({unit_amount: String}) } def to_hash; end end @@ -410,8 +445,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -431,14 +470,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -485,8 +517,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -506,14 +542,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -671,19 +700,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, package_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :package ); end @@ -717,8 +767,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence::TaggedSymbol) SEMI_ANNUAL = @@ -749,8 +798,13 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:); end - + def self.new( + # A currency amount to rate usage by + package_amount:, + # An integer amount to represent package size. For example, 1000 here would divide + # usage by 1000 before multiplying by package_amount in rating + package_size: + ); end sig { override.returns({package_amount: String, package_size: Integer}) } def to_hash; end end @@ -777,8 +831,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -798,14 +856,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -852,8 +903,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -873,14 +928,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1038,19 +1086,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, matrix_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :matrix ); end @@ -1084,8 +1153,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence::TaggedSymbol) SEMI_ANNUAL = @@ -1130,8 +1198,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:); end - + def self.new( + # Default per unit rate for any usage not bucketed into a specified matrix_value + default_unit_amount:, + # One or two event property values to evaluate matrix groups by + dimensions:, + # Matrix values for specified matrix grouping keys + matrix_values: + ); end sig do override .returns( @@ -1161,8 +1235,14 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:); end - + def self.new( + # One or two matrix keys to filter usage to this Matrix value by. For example, + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. + dimension_values:, + # Unit price for the specified dimension_values + unit_amount: + ); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } def to_hash; end end @@ -1190,8 +1270,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1211,14 +1295,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1265,8 +1342,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1286,14 +1367,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1451,19 +1525,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :tiered ); end @@ -1497,8 +1592,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence::TaggedSymbol) SEMI_ANNUAL = @@ -1533,8 +1627,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for rating based on total usage quantities into the specified tier + tiers: + ); end sig do override .returns({tiers: T::Array[Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::TieredConfig::Tier]}) @@ -1561,8 +1657,14 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil); end - + def self.new( + # Exclusive tier starting value + first_unit:, + # Amount per unit + unit_amount:, + # Inclusive tier ending value. If null, this is treated as the last tier + last_unit: nil + ); end sig { override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) } def to_hash; end end @@ -1590,8 +1692,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1611,14 +1717,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1665,8 +1764,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1686,14 +1789,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1861,19 +1957,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_bps_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :tiered_bps ); end @@ -1907,8 +2024,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence::TaggedSymbol) @@ -1947,8 +2063,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # tiers + tiers: + ); end sig do override .returns( @@ -1983,8 +2102,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Per-event basis point rate + bps:, + # Exclusive tier starting value + minimum_amount:, + # Inclusive tier ending value + maximum_amount: nil, + # Per unit maximum to charge + per_unit_maximum: nil + ); end sig do override .returns( @@ -2022,8 +2149,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2043,14 +2174,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2097,8 +2221,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2118,14 +2246,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2284,18 +2405,39 @@ module Orb end def self.new( bps_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :bps ); end @@ -2333,8 +2475,12 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil); end - + def self.new( + # Basis point take rate per event + bps:, + # Optional currency amount maximum to cap spend per event + per_unit_maximum: nil + ); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } def to_hash; end end @@ -2345,8 +2491,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence::TaggedSymbol) SEMI_ANNUAL = @@ -2383,8 +2528,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2404,14 +2553,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2458,8 +2600,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2479,14 +2625,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2645,18 +2784,39 @@ module Orb end def self.new( bulk_bps_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :bulk_bps ); end @@ -2701,8 +2861,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a bulk BPS pricing model where all usage is aggregated to a single + # tier based on total volume + tiers: + ); end sig do override .returns({tiers: T::Array[Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig::Tier]}) @@ -2726,8 +2889,14 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Basis points to rate on + bps:, + # Upper bound for tier + maximum_amount: nil, + # The maximum amount to charge for any one event + per_unit_maximum: nil + ); end sig do override.returns( { @@ -2747,8 +2916,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence::TaggedSymbol) SEMI_ANNUAL = @@ -2790,8 +2958,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2811,14 +2983,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2865,8 +3030,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2886,14 +3055,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3052,18 +3214,39 @@ module Orb end def self.new( bulk_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :bulk ); end @@ -3102,8 +3285,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Bulk tiers for rating based on total usage volume + tiers: + ); end sig do override .returns({tiers: T::Array[Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BulkConfig::Tier]}) @@ -3120,8 +3305,12 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil); end - + def self.new( + # Amount per unit + unit_amount:, + # Upper bound for this tier + maximum_units: nil + ); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } def to_hash; end end @@ -3133,8 +3322,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence::TaggedSymbol) SEMI_ANNUAL = @@ -3172,8 +3360,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3193,14 +3385,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3247,8 +3432,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3268,14 +3457,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3437,19 +3619,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, threshold_total_amount_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :threshold_total_amount ); end @@ -3487,14 +3690,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -3558,8 +3754,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3579,14 +3779,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3633,8 +3826,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3654,14 +3851,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3819,19 +4009,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_package_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :tiered_package ); end @@ -3865,14 +4076,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence::TaggedSymbol) @@ -3919,8 +4123,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3940,14 +4148,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3994,8 +4195,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4015,14 +4220,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4182,19 +4380,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_with_minimum_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :tiered_with_minimum ); end @@ -4230,14 +4449,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence::TaggedSymbol) @@ -4295,8 +4507,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4316,14 +4532,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4370,8 +4579,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4391,14 +4604,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4556,19 +4762,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_with_percent_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :unit_with_percent ); end @@ -4602,14 +4829,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence::TaggedSymbol) @@ -4661,8 +4881,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4682,14 +4906,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4736,8 +4953,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4757,14 +4978,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4926,19 +5140,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, package_with_allocation_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :package_with_allocation ); end @@ -4976,14 +5211,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -5047,8 +5275,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5068,14 +5300,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5122,8 +5347,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5143,14 +5372,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5310,19 +5532,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_with_proration_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :tiered_with_proration ); end @@ -5358,14 +5601,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence::TaggedSymbol) @@ -5423,8 +5659,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5444,14 +5684,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5498,8 +5731,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5519,14 +5756,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5686,19 +5916,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_with_proration_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :unit_with_proration ); end @@ -5734,14 +5985,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence::TaggedSymbol) @@ -5799,8 +6043,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5820,14 +6068,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5874,8 +6115,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5895,14 +6140,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6062,19 +6300,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_allocation_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :grouped_allocation ); end @@ -6110,14 +6369,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence::TaggedSymbol) @@ -6175,8 +6427,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6196,14 +6452,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6250,8 +6499,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6271,14 +6524,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6440,19 +6686,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_with_prorated_minimum_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :grouped_with_prorated_minimum ); end @@ -6490,14 +6757,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -6561,8 +6821,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6582,14 +6846,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6636,8 +6893,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6657,14 +6918,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6826,19 +7080,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_with_metered_minimum_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :grouped_with_metered_minimum ); end @@ -6876,14 +7151,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -6947,8 +7215,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6968,14 +7240,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7022,8 +7287,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7043,14 +7312,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7212,19 +7474,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, matrix_with_display_name_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :matrix_with_display_name ); end @@ -7262,14 +7545,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -7333,8 +7609,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7354,14 +7634,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7408,8 +7681,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7429,14 +7706,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7597,18 +7867,39 @@ module Orb end def self.new( bulk_with_proration_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :bulk_with_proration ); end @@ -7644,14 +7935,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence::TaggedSymbol) @@ -7709,8 +7993,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7730,14 +8018,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7784,8 +8065,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7805,14 +8090,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7974,19 +8252,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_tiered_package_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :grouped_tiered_package ); end @@ -8024,14 +8323,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -8095,8 +8387,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8116,14 +8412,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8170,8 +8459,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8191,14 +8484,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8360,19 +8646,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, max_group_tiered_package_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :max_group_tiered_package ); end @@ -8410,14 +8717,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -8481,8 +8781,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8502,14 +8806,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8556,8 +8853,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8577,14 +8878,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8750,19 +9044,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, scalable_matrix_with_unit_pricing_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :scalable_matrix_with_unit_pricing ); end @@ -8800,14 +9115,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -8871,8 +9179,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8892,14 +9204,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8946,8 +9251,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8967,14 +9276,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9140,19 +9442,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, scalable_matrix_with_tiered_pricing_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :scalable_matrix_with_tiered_pricing ); end @@ -9190,14 +9513,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -9261,8 +9577,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9282,14 +9602,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9336,8 +9649,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9357,14 +9674,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9526,19 +9836,40 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, cumulative_grouped_bulk_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :cumulative_grouped_bulk ); end @@ -9576,14 +9907,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -9647,8 +9971,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9668,14 +9996,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9722,8 +10043,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9743,14 +10068,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9791,7 +10109,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::PlanCreateParams::Status::TaggedSymbol) DRAFT = T.let(:draft, Orb::Models::PlanCreateParams::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/plan_list_params.rbi b/rbi/lib/orb/models/plan_list_params.rbi index 7ca1b43c..b6527fea 100644 --- a/rbi/lib/orb/models/plan_list_params.rbi +++ b/rbi/lib/orb/models/plan_list_params.rbi @@ -55,8 +55,12 @@ module Orb created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. cursor: nil, + # The number of items to fetch. Defaults to 20. limit: nil, + # The plan status to filter to ('active', 'archived', or 'draft'). status: nil, request_options: {} ); end @@ -82,7 +86,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanListParams::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::PlanListParams::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::PlanListParams::Status::TaggedSymbol) ARCHIVED = T.let(:archived, Orb::Models::PlanListParams::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/plan_update_params.rbi b/rbi/lib/orb/models/plan_update_params.rbi index 0c0e701c..a2ad18df 100644 --- a/rbi/lib/orb/models/plan_update_params.rbi +++ b/rbi/lib/orb/models/plan_update_params.rbi @@ -26,8 +26,17 @@ module Orb ) .returns(T.attached_class) end - def self.new(external_plan_id: nil, metadata: nil, request_options: {}); end - + def self.new( + # An optional user-defined ID for this plan resource, used throughout the system + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. + external_plan_id: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. + metadata: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi b/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi index e2279cdb..693b6be2 100644 --- a/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +++ b/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi @@ -27,8 +27,17 @@ module Orb ) .returns(T.attached_class) end - def self.new(external_plan_id: nil, metadata: nil, request_options: {}); end - + def self.new( + # An optional user-defined ID for this plan resource, used throughout the system + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. + external_plan_id: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. + metadata: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/price.rbi b/rbi/lib/orb/models/price.rbi index ed4aff59..8b452d3b 100644 --- a/rbi/lib/orb/models/price.rbi +++ b/rbi/lib/orb/models/price.rbi @@ -208,6 +208,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -301,14 +305,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::UnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::UnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -326,7 +323,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitPrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::UnitPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::UnitPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::UnitPrice::Cadence::TaggedSymbol) @@ -385,14 +382,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -433,8 +423,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -452,8 +447,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -462,7 +462,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitPrice::PriceType) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::UnitPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::UnitPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::UnitPrice::PriceType::TaggedSymbol) @@ -477,8 +477,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:); end - + def self.new( + # Rate per unit of usage + unit_amount: + ); end sig { override.returns({unit_amount: String}) } def to_hash; end end @@ -698,6 +700,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -791,14 +797,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::PackagePrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::PackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::PackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -817,8 +816,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::PackagePrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::PackagePrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::PackagePrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::PackagePrice::Cadence::TaggedSymbol) @@ -877,14 +875,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -928,8 +919,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -947,8 +943,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -964,8 +965,13 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:); end - + def self.new( + # A currency amount to rate usage by + package_amount:, + # An integer amount to represent package size. For example, 1000 here would divide + # usage by 1000 before multiplying by package_amount in rating + package_size: + ); end sig { override.returns({package_amount: String, package_size: Integer}) } def to_hash; end end @@ -974,8 +980,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::PackagePrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::PackagePrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::PackagePrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::PackagePrice::PriceType::TaggedSymbol) @@ -1198,6 +1203,10 @@ module Orb matrix_config:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -1290,14 +1299,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::MatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::MatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -1315,7 +1317,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixPrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::MatrixPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::MatrixPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::MatrixPrice::Cadence::TaggedSymbol) @@ -1374,14 +1376,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -1433,8 +1428,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:); end - + def self.new( + # Default per unit rate for any usage not bucketed into a specified matrix_value + default_unit_amount:, + # One or two event property values to evaluate matrix groups by + dimensions:, + # Matrix values for specified matrix grouping keys + matrix_values: + ); end sig do override .returns( @@ -1464,8 +1465,14 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:); end - + def self.new( + # One or two matrix keys to filter usage to this Matrix value by. For example, + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. + dimension_values:, + # Unit price for the specified dimension_values + unit_amount: + ); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } def to_hash; end end @@ -1484,8 +1491,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -1503,8 +1515,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -1513,8 +1530,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::MatrixPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::MatrixPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::MatrixPrice::PriceType::TaggedSymbol) @@ -1736,6 +1752,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -1829,14 +1849,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::TieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::TieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -1854,7 +1867,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::TieredPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::TieredPrice::Cadence::TaggedSymbol) @@ -1913,14 +1926,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -1964,8 +1970,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -1983,8 +1994,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -1993,8 +2009,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::TieredPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredPrice::PriceType::TaggedSymbol) @@ -2014,8 +2029,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for rating based on total usage quantities into the specified tier + tiers: + ); end sig { override.returns({tiers: T::Array[Orb::Models::Price::TieredPrice::TieredConfig::Tier]}) } def to_hash; end @@ -2039,8 +2056,14 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil); end - + def self.new( + # Exclusive tier starting value + first_unit:, + # Amount per unit + unit_amount:, + # Inclusive tier ending value. If null, this is treated as the last tier + last_unit: nil + ); end sig { override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) } def to_hash; end end @@ -2272,6 +2295,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -2365,14 +2392,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -2393,8 +2413,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredBpsPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredBpsPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::TieredBpsPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::TieredBpsPrice::Cadence::TaggedSymbol) @@ -2453,14 +2472,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -2504,8 +2516,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -2523,8 +2540,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -2533,8 +2555,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredBpsPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredBpsPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::TieredBpsPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredBpsPrice::PriceType::TaggedSymbol) @@ -2555,8 +2576,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # tiers + tiers: + ); end sig { override.returns({tiers: T::Array[Orb::Models::Price::TieredBpsPrice::TieredBpsConfig::Tier]}) } def to_hash; end @@ -2586,8 +2610,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Per-event basis point rate + bps:, + # Exclusive tier starting value + minimum_amount:, + # Inclusive tier ending value + maximum_amount: nil, + # Per unit maximum to charge + per_unit_maximum: nil + ); end sig do override .returns( @@ -2817,6 +2849,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -2909,8 +2945,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BpsPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::BpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::BpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -2934,8 +2969,12 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil); end - + def self.new( + # Basis point take rate per event + bps:, + # Optional currency amount maximum to cap spend per event + per_unit_maximum: nil + ); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } def to_hash; end end @@ -2944,7 +2983,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BpsPrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::BpsPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::BpsPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::BpsPrice::Cadence::TaggedSymbol) @@ -3003,14 +3042,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -3051,8 +3083,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -3070,8 +3107,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -3080,7 +3122,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BpsPrice::PriceType) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::BpsPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::BpsPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::BpsPrice::PriceType::TaggedSymbol) @@ -3306,6 +3348,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -3398,14 +3444,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -3432,8 +3471,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a bulk BPS pricing model where all usage is aggregated to a single + # tier based on total volume + tiers: + ); end sig { override.returns({tiers: T::Array[Orb::Models::Price::BulkBpsPrice::BulkBpsConfig::Tier]}) } def to_hash; end @@ -3454,8 +3496,14 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Basis points to rate on + bps:, + # Upper bound for tier + maximum_amount: nil, + # The maximum amount to charge for any one event + per_unit_maximum: nil + ); end sig do override.returns( { @@ -3473,8 +3521,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkBpsPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::BulkBpsPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::BulkBpsPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::BulkBpsPrice::Cadence::TaggedSymbol) @@ -3533,14 +3580,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -3584,8 +3624,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -3603,8 +3648,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -3613,8 +3663,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkBpsPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::BulkBpsPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::BulkBpsPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::BulkBpsPrice::PriceType::TaggedSymbol) @@ -3837,6 +3886,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -3929,14 +3982,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::BulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::BulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -3959,8 +4005,10 @@ module Orb params(tiers: T::Array[T.any(Orb::Models::Price::BulkPrice::BulkConfig::Tier, Orb::Internal::AnyHash)]) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Bulk tiers for rating based on total usage volume + tiers: + ); end sig { override.returns({tiers: T::Array[Orb::Models::Price::BulkPrice::BulkConfig::Tier]}) } def to_hash; end @@ -3974,8 +4022,12 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil); end - + def self.new( + # Amount per unit + unit_amount:, + # Upper bound for this tier + maximum_units: nil + ); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } def to_hash; end end @@ -3985,7 +4037,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkPrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::BulkPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::BulkPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::BulkPrice::Cadence::TaggedSymbol) @@ -4044,14 +4096,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -4092,8 +4137,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -4111,8 +4161,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -4121,7 +4176,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkPrice::PriceType) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::BulkPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::BulkPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::BulkPrice::PriceType::TaggedSymbol) @@ -4364,6 +4419,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -4461,14 +4520,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::ThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4495,8 +4547,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::ThresholdTotalAmountPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::ThresholdTotalAmountPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::ThresholdTotalAmountPrice::Cadence::TaggedSymbol) @@ -4559,14 +4610,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::ThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4616,8 +4660,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -4635,8 +4684,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -4645,8 +4699,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::ThresholdTotalAmountPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::ThresholdTotalAmountPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::ThresholdTotalAmountPrice::PriceType::TaggedSymbol) @@ -4879,6 +4932,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -4972,14 +5029,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPackagePrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::TieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::TieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -5003,8 +5053,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPackagePrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredPackagePrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::TieredPackagePrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::TieredPackagePrice::Cadence::TaggedSymbol) @@ -5063,14 +5112,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::TieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5120,8 +5162,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -5139,8 +5186,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -5149,8 +5201,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPackagePrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredPackagePrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::TieredPackagePrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredPackagePrice::PriceType::TaggedSymbol) @@ -5384,6 +5435,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -5476,14 +5531,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedTieredPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::GroupedTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::Price::GroupedTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -5507,8 +5555,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedTieredPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedTieredPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::GroupedTieredPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::GroupedTieredPrice::Cadence::TaggedSymbol) @@ -5567,14 +5614,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::GroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5624,8 +5664,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -5643,8 +5688,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -5653,8 +5703,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedTieredPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedTieredPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::GroupedTieredPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::GroupedTieredPrice::PriceType::TaggedSymbol) @@ -5891,6 +5940,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -5984,14 +6037,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::TieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6018,8 +6064,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredWithMinimumPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredWithMinimumPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::TieredWithMinimumPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::TieredWithMinimumPrice::Cadence::TaggedSymbol) @@ -6082,14 +6127,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::TieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6139,8 +6177,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -6158,8 +6201,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -6168,8 +6216,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredWithMinimumPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredWithMinimumPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::TieredWithMinimumPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredWithMinimumPrice::PriceType::TaggedSymbol) @@ -6432,6 +6479,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -6529,14 +6580,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::TieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6563,8 +6607,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredPackageWithMinimumPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::TieredPackageWithMinimumPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::TieredPackageWithMinimumPrice::Cadence::TaggedSymbol) @@ -6630,14 +6673,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::TieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6687,8 +6723,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -6706,8 +6747,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -6717,8 +6763,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredPackageWithMinimumPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::TieredPackageWithMinimumPrice::PriceType::TaggedSymbol) @@ -6963,6 +7008,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -7060,14 +7109,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::PackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::PackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7094,8 +7136,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::PackageWithAllocationPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::PackageWithAllocationPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::PackageWithAllocationPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::PackageWithAllocationPrice::Cadence::TaggedSymbol) @@ -7158,14 +7199,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::PackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::PackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7215,8 +7249,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -7234,8 +7273,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -7244,8 +7288,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::PackageWithAllocationPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::PackageWithAllocationPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::PackageWithAllocationPrice::PriceType::TaggedSymbol) @@ -7484,6 +7527,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -7577,14 +7624,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitWithPercentPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::UnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7611,8 +7651,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitWithPercentPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::UnitWithPercentPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::UnitWithPercentPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::UnitWithPercentPrice::Cadence::TaggedSymbol) @@ -7671,14 +7710,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::UnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7728,8 +7760,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -7747,8 +7784,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -7757,8 +7799,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitWithPercentPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::UnitWithPercentPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::UnitWithPercentPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::UnitWithPercentPrice::PriceType::TaggedSymbol) @@ -8010,6 +8051,10 @@ module Orb matrix_with_allocation_config:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -8106,14 +8151,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::MatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8140,8 +8178,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixWithAllocationPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::MatrixWithAllocationPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::MatrixWithAllocationPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::MatrixWithAllocationPrice::Cadence::TaggedSymbol) @@ -8204,14 +8241,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::MatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8279,8 +8309,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(allocation:, default_unit_amount:, dimensions:, matrix_values:); end - + def self.new( + # Allocation to be used to calculate the price + allocation:, + # Default per unit rate for any usage not bucketed into a specified matrix_value + default_unit_amount:, + # One or two event property values to evaluate matrix groups by + dimensions:, + # Matrix values for specified matrix grouping keys + matrix_values: + ); end sig do override .returns( @@ -8311,8 +8349,14 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:); end - + def self.new( + # One or two matrix keys to filter usage to this Matrix value by. For example, + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. + dimension_values:, + # Unit price for the specified dimension_values + unit_amount: + ); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } def to_hash; end end @@ -8331,8 +8375,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -8350,8 +8399,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -8360,8 +8414,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixWithAllocationPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::MatrixWithAllocationPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::MatrixWithAllocationPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::MatrixWithAllocationPrice::PriceType::TaggedSymbol) @@ -8598,6 +8651,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -8695,14 +8752,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredWithProrationPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::TieredWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8729,8 +8779,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredWithProrationPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredWithProrationPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::TieredWithProrationPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::TieredWithProrationPrice::Cadence::TaggedSymbol) @@ -8793,14 +8842,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::TieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8850,8 +8892,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -8869,8 +8916,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -8879,8 +8931,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredWithProrationPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredWithProrationPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::TieredWithProrationPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredWithProrationPrice::PriceType::TaggedSymbol) @@ -9117,6 +9168,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -9210,14 +9265,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitWithProrationPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::UnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9244,8 +9292,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitWithProrationPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::UnitWithProrationPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::UnitWithProrationPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::UnitWithProrationPrice::Cadence::TaggedSymbol) @@ -9308,14 +9355,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::UnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9365,8 +9405,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -9384,8 +9429,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -9394,8 +9444,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitWithProrationPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::UnitWithProrationPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::UnitWithProrationPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::UnitWithProrationPrice::PriceType::TaggedSymbol) @@ -9633,6 +9682,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -9725,14 +9778,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedAllocationPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::GroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9759,8 +9805,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedAllocationPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedAllocationPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::GroupedAllocationPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::GroupedAllocationPrice::Cadence::TaggedSymbol) @@ -9823,14 +9868,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::GroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9880,8 +9918,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -9899,8 +9942,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -9909,8 +9957,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedAllocationPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedAllocationPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::GroupedAllocationPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::GroupedAllocationPrice::PriceType::TaggedSymbol) @@ -10176,6 +10223,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -10274,14 +10325,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::GroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10309,8 +10353,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedWithProratedMinimumPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::GroupedWithProratedMinimumPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::GroupedWithProratedMinimumPrice::Cadence::TaggedSymbol) @@ -10376,14 +10419,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::GroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10435,8 +10471,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -10454,8 +10495,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -10465,8 +10511,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedWithProratedMinimumPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::GroupedWithProratedMinimumPrice::PriceType::TaggedSymbol) @@ -10732,6 +10777,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -10828,14 +10877,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10863,8 +10905,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::GroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::GroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol) @@ -10930,14 +10971,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::GroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10989,8 +11023,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -11008,8 +11047,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -11019,8 +11063,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedWithMeteredMinimumPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::GroupedWithMeteredMinimumPrice::PriceType::TaggedSymbol) @@ -11266,6 +11309,10 @@ module Orb matrix_with_display_name_config:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -11362,14 +11409,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::MatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11396,8 +11436,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::MatrixWithDisplayNamePrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::MatrixWithDisplayNamePrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::MatrixWithDisplayNamePrice::Cadence::TaggedSymbol) @@ -11460,14 +11499,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::MatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11517,8 +11549,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -11536,8 +11573,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -11546,8 +11588,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::MatrixWithDisplayNamePrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::MatrixWithDisplayNamePrice::PriceType::TaggedSymbol) @@ -11787,6 +11828,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -11879,14 +11924,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkWithProrationPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::BulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11913,8 +11951,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkWithProrationPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::BulkWithProrationPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::BulkWithProrationPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::BulkWithProrationPrice::Cadence::TaggedSymbol) @@ -11977,14 +12014,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::BulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -12034,8 +12064,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -12053,8 +12088,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -12063,8 +12103,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkWithProrationPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::BulkWithProrationPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::BulkWithProrationPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::BulkWithProrationPrice::PriceType::TaggedSymbol) @@ -12308,6 +12347,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -12404,14 +12447,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::GroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -12438,8 +12474,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedTieredPackagePrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedTieredPackagePrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::GroupedTieredPackagePrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::GroupedTieredPackagePrice::Cadence::TaggedSymbol) @@ -12502,14 +12537,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::GroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -12559,8 +12587,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -12578,8 +12611,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -12588,8 +12626,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedTieredPackagePrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedTieredPackagePrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::GroupedTieredPackagePrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::GroupedTieredPackagePrice::PriceType::TaggedSymbol) @@ -12833,6 +12870,10 @@ module Orb max_group_tiered_package_config:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -12929,14 +12970,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::MaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -12963,8 +12997,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::MaxGroupTieredPackagePrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::MaxGroupTieredPackagePrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::MaxGroupTieredPackagePrice::Cadence::TaggedSymbol) @@ -13027,14 +13060,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::MaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -13084,8 +13110,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -13103,8 +13134,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -13113,8 +13149,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::MaxGroupTieredPackagePrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::MaxGroupTieredPackagePrice::PriceType::TaggedSymbol) @@ -13382,6 +13417,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -13481,14 +13520,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -13518,8 +13550,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol) @@ -13587,14 +13618,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -13646,8 +13670,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -13665,8 +13694,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -13676,8 +13710,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::PriceType::TaggedSymbol) @@ -13961,6 +13994,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -14060,14 +14097,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -14097,8 +14127,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol) @@ -14169,14 +14198,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -14228,8 +14250,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -14247,8 +14274,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -14258,8 +14290,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::PriceType::TaggedSymbol) @@ -14508,6 +14539,10 @@ module Orb item:, maximum:, maximum_amount:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, minimum:, minimum_amount:, @@ -14604,14 +14639,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::CumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -14638,8 +14666,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::Cadence) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::CumulativeGroupedBulkPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::Price::CumulativeGroupedBulkPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::CumulativeGroupedBulkPrice::Cadence::TaggedSymbol) @@ -14702,14 +14729,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::Price::CumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -14759,8 +14779,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:); end - + def self.new( + # List of price_ids that this maximum amount applies to. For plan/plan phase + # maximums, this can be a subset of prices. + applies_to_price_ids:, + # Maximum amount applied + maximum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } def to_hash; end end @@ -14778,8 +14803,13 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:); end - + def self.new( + # List of price_ids that this minimum amount applies to. For plan/plan phase + # minimums, this can be a subset of prices. + applies_to_price_ids:, + # Minimum amount applied + minimum_amount: + ); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } def to_hash; end end @@ -14788,8 +14818,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::PriceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::Price::CumulativeGroupedBulkPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::CumulativeGroupedBulkPrice::PriceType::TaggedSymbol) diff --git a/rbi/lib/orb/models/price_create_params.rbi b/rbi/lib/orb/models/price_create_params.rbi index d76ac410..d7e553be 100644 --- a/rbi/lib/orb/models/price_create_params.rbi +++ b/rbi/lib/orb/models/price_create_params.rbi @@ -252,10 +252,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, model_type:, + # The name of the price. name:, unit_config:, package_config:, @@ -285,14 +289,30 @@ module Orb scalable_matrix_with_unit_pricing_config:, scalable_matrix_with_tiered_pricing_config:, cumulative_grouped_bulk_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, request_options: {} ); end @@ -353,7 +373,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PriceCreateParams::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let(:annual, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol) SEMI_ANNUAL = T.let(:semi_annual, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol) @@ -370,8 +390,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PriceCreateParams::ModelType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::PriceCreateParams::ModelType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CUMULATIVE_GROUPED_BULK = T.let(:cumulative_grouped_bulk, Orb::Models::PriceCreateParams::ModelType::TaggedSymbol) @@ -386,8 +405,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:); end - + def self.new( + # Rate per unit of usage + unit_amount: + ); end sig { override.returns({unit_amount: String}) } def to_hash; end end @@ -410,8 +431,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -429,14 +454,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -468,8 +486,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -487,14 +509,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -520,8 +535,13 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:); end - + def self.new( + # A currency amount to rate usage by + package_amount:, + # An integer amount to represent package size. For example, 1000 here would divide + # usage by 1000 before multiplying by package_amount in rating + package_size: + ); end sig { override.returns({package_amount: String, package_size: Integer}) } def to_hash; end end @@ -547,8 +567,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:); end - + def self.new( + # Default per unit rate for any usage not bucketed into a specified matrix_value + default_unit_amount:, + # One or two event property values to evaluate matrix groups by + dimensions:, + # Matrix values for specified matrix grouping keys + matrix_values: + ); end sig do override .returns( @@ -578,8 +604,14 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:); end - + def self.new( + # One or two matrix keys to filter usage to this Matrix value by. For example, + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. + dimension_values:, + # Unit price for the specified dimension_values + unit_amount: + ); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } def to_hash; end end @@ -611,8 +643,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(allocation:, default_unit_amount:, dimensions:, matrix_values:); end - + def self.new( + # Allocation to be used to calculate the price + allocation:, + # Default per unit rate for any usage not bucketed into a specified matrix_value + default_unit_amount:, + # One or two event property values to evaluate matrix groups by + dimensions:, + # Matrix values for specified matrix grouping keys + matrix_values: + ); end sig do override .returns( @@ -643,8 +683,14 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:); end - + def self.new( + # One or two matrix keys to filter usage to this Matrix value by. For example, + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. + dimension_values:, + # Unit price for the specified dimension_values + unit_amount: + ); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } def to_hash; end end @@ -659,8 +705,10 @@ module Orb params(tiers: T::Array[T.any(Orb::Models::PriceCreateParams::TieredConfig::Tier, Orb::Internal::AnyHash)]) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for rating based on total usage quantities into the specified tier + tiers: + ); end sig { override.returns({tiers: T::Array[Orb::Models::PriceCreateParams::TieredConfig::Tier]}) } def to_hash; end @@ -684,8 +732,14 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil); end - + def self.new( + # Exclusive tier starting value + first_unit:, + # Amount per unit + unit_amount:, + # Inclusive tier ending value. If null, this is treated as the last tier + last_unit: nil + ); end sig { override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) } def to_hash; end end @@ -703,8 +757,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # tiers + tiers: + ); end sig { override.returns({tiers: T::Array[Orb::Models::PriceCreateParams::TieredBpsConfig::Tier]}) } def to_hash; end @@ -734,8 +791,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Per-event basis point rate + bps:, + # Exclusive tier starting value + minimum_amount:, + # Inclusive tier ending value + maximum_amount: nil, + # Per unit maximum to charge + per_unit_maximum: nil + ); end sig do override .returns( @@ -761,8 +826,12 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil); end - + def self.new( + # Basis point take rate per event + bps:, + # Optional currency amount maximum to cap spend per event + per_unit_maximum: nil + ); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } def to_hash; end end @@ -779,8 +848,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a bulk BPS pricing model where all usage is aggregated to a single + # tier based on total volume + tiers: + ); end sig { override.returns({tiers: T::Array[Orb::Models::PriceCreateParams::BulkBpsConfig::Tier]}) } def to_hash; end @@ -801,8 +873,14 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Basis points to rate on + bps:, + # Upper bound for tier + maximum_amount: nil, + # The maximum amount to charge for any one event + per_unit_maximum: nil + ); end sig do override.returns( { @@ -825,8 +903,10 @@ module Orb params(tiers: T::Array[T.any(Orb::Models::PriceCreateParams::BulkConfig::Tier, Orb::Internal::AnyHash)]) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Bulk tiers for rating based on total usage volume + tiers: + ); end sig { override.returns({tiers: T::Array[Orb::Models::PriceCreateParams::BulkConfig::Tier]}) } def to_hash; end @@ -840,8 +920,12 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil); end - + def self.new( + # Amount per unit + unit_amount:, + # Upper bound for this tier + maximum_units: nil + ); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } def to_hash; end end diff --git a/rbi/lib/orb/models/price_evaluate_params.rbi b/rbi/lib/orb/models/price_evaluate_params.rbi index d10936c5..91dff47a 100644 --- a/rbi/lib/orb/models/price_evaluate_params.rbi +++ b/rbi/lib/orb/models/price_evaluate_params.rbi @@ -50,11 +50,21 @@ module Orb .returns(T.attached_class) end def self.new( + # The exclusive upper bound for event timestamps timeframe_end:, + # The inclusive lower bound for event timestamps timeframe_start:, + # The ID of the customer to which this evaluation is scoped. customer_id: nil, + # The external customer ID of the customer to which this evaluation is scoped. external_customer_id: nil, + # A boolean + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the underlying billable metric filter: nil, + # Properties (or + # [computed properties](/extensibility/advanced-metrics#computed-properties)) used + # to group the underlying billable metric grouping_keys: nil, request_options: {} ); end diff --git a/rbi/lib/orb/models/price_list_params.rbi b/rbi/lib/orb/models/price_list_params.rbi index 55ab5eb8..e55bbd7d 100644 --- a/rbi/lib/orb/models/price_list_params.rbi +++ b/rbi/lib/orb/models/price_list_params.rbi @@ -26,8 +26,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}); end - + def self.new( + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. + cursor: nil, + # The number of items to fetch. Defaults to 20. + limit: nil, + request_options: {} + ); end sig do override.returns({cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOptions}) end diff --git a/rbi/lib/orb/models/price_update_params.rbi b/rbi/lib/orb/models/price_update_params.rbi index 81199181..abf4b50f 100644 --- a/rbi/lib/orb/models/price_update_params.rbi +++ b/rbi/lib/orb/models/price_update_params.rbi @@ -19,8 +19,13 @@ module Orb ) .returns(T.attached_class) end - def self.new(metadata: nil, request_options: {}); end - + def self.new( + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. + metadata: nil, + request_options: {} + ); end sig do override .returns({ diff --git a/rbi/lib/orb/models/prices/external_price_id_update_params.rbi b/rbi/lib/orb/models/prices/external_price_id_update_params.rbi index 4f7bdbc6..ab1024fd 100644 --- a/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +++ b/rbi/lib/orb/models/prices/external_price_id_update_params.rbi @@ -20,8 +20,13 @@ module Orb ) .returns(T.attached_class) end - def self.new(metadata: nil, request_options: {}); end - + def self.new( + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. + metadata: nil, + request_options: {} + ); end sig do override .returns({ diff --git a/rbi/lib/orb/models/subscription.rbi b/rbi/lib/orb/models/subscription.rbi index 725e8eb0..38f248de 100644 --- a/rbi/lib/orb/models/subscription.rbi +++ b/rbi/lib/orb/models/subscription.rbi @@ -239,28 +239,84 @@ module Orb end def self.new( id:, + # The current plan phase that is active, only if the subscription's plan has + # phases. active_plan_phase_order:, + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. adjustment_intervals:, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. auto_collection:, billing_cycle_anchor_configuration:, + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. billing_cycle_day:, created_at:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. current_billing_period_start_date:, + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. customer:, + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo:, + # The discount intervals for this subscription sorted by the start_date. discount_intervals:, + # The date Orb stops billing for this subscription. end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, + # The maximum intervals for this subscription sorted by the start_date. maximum_intervals:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The minimum intervals for this subscription sorted by the start_date. minimum_intervals:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms:, + # A pending subscription change if one exists on this subscription. pending_subscription_change:, + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). plan:, + # The price intervals for this subscription. price_intervals:, redeemed_coupon:, + # The date Orb starts billing for this subscription. start_date:, status:, trial_info: @@ -352,8 +408,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end - + def self.new( + id:, + adjustment:, + # The price interval IDs that this adjustment applies to. + applies_to_price_interval_ids:, + # The end date of the adjustment interval. + end_date:, + # The start date of the adjustment interval. + start_date: + ); end sig do override .returns( @@ -420,10 +484,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -487,10 +558,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -554,10 +632,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -626,11 +711,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -695,10 +788,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -751,8 +851,20 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -796,10 +908,15 @@ module Orb .returns(T.attached_class) end def self.new( + # Only available if discount_type is `amount`. amount_discount:, + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, discount_type: :amount ); end @@ -856,10 +973,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. percentage_discount:, + # The start date of the discount interval. start_date:, discount_type: :percentage ); end @@ -916,10 +1039,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for usage_discount:, discount_type: :usage ); end @@ -1006,14 +1135,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this maximum interval applies to. applies_to_price_ids:, + # The price interval ids that this maximum interval applies to. applies_to_price_interval_ids:, + # The end date of the maximum interval. end_date:, + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. maximum_amount:, + # The start date of the maximum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1062,14 +1195,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this minimum interval applies to. applies_to_price_ids:, + # The price interval ids that this minimum interval applies to. applies_to_price_interval_ids:, + # The end date of the minimum interval. end_date:, + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. minimum_amount:, + # The start date of the minimum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1239,14 +1376,40 @@ module Orb end def self.new( id:, + # The day of the month that Orb bills for this price billing_cycle_day:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. current_billing_period_start_date:, + # The end date of the price interval. This is the date that Orb stops billing for + # this price. end_date:, + # An additional filter to apply to usage queries. filter:, + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. fixed_fee_quantity_transitions:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # The start date of the price interval. This is the date that Orb starts billing + # for this price. start_date:, + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. usage_customer_ids: ); end sig do @@ -1338,7 +1501,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Subscription::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Subscription::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::Subscription::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::Subscription::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_cancel_params.rbi b/rbi/lib/orb/models/subscription_cancel_params.rbi index d3c78425..8637a253 100644 --- a/rbi/lib/orb/models/subscription_cancel_params.rbi +++ b/rbi/lib/orb/models/subscription_cancel_params.rbi @@ -31,13 +31,17 @@ module Orb .returns(T.attached_class) end def self.new( + # Determines the timing of subscription cancellation cancel_option:, + # If false, this request will fail if it would void an issued invoice or create a + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. allow_invoice_credit_or_void: nil, + # The date that the cancellation should take effect. This parameter can only be + # passed if the `cancel_option` is `requested_date`. cancellation_date: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -56,8 +60,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCancelParams::CancelOption) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionCancelParams::CancelOption::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } END_OF_SUBSCRIPTION_TERM = T.let(:end_of_subscription_term, Orb::Models::SubscriptionCancelParams::CancelOption::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_cancel_response.rbi b/rbi/lib/orb/models/subscription_cancel_response.rbi index 6353c6ac..0d89d2da 100644 --- a/rbi/lib/orb/models/subscription_cancel_response.rbi +++ b/rbi/lib/orb/models/subscription_cancel_response.rbi @@ -239,31 +239,90 @@ module Orb end def self.new( id:, + # The current plan phase that is active, only if the subscription's plan has + # phases. active_plan_phase_order:, + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. adjustment_intervals:, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. auto_collection:, billing_cycle_anchor_configuration:, + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. billing_cycle_day:, created_at:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. current_billing_period_start_date:, + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. customer:, + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo:, + # The discount intervals for this subscription sorted by the start_date. discount_intervals:, + # The date Orb stops billing for this subscription. end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, + # The maximum intervals for this subscription sorted by the start_date. maximum_intervals:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The minimum intervals for this subscription sorted by the start_date. minimum_intervals:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms:, + # A pending subscription change if one exists on this subscription. pending_subscription_change:, + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). plan:, + # The price intervals for this subscription. price_intervals:, redeemed_coupon:, + # The date Orb starts billing for this subscription. start_date:, status:, trial_info:, + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. changed_resources: nil ); end sig do @@ -354,8 +413,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end - + def self.new( + id:, + adjustment:, + # The price interval IDs that this adjustment applies to. + applies_to_price_interval_ids:, + # The end date of the adjustment interval. + end_date:, + # The start date of the adjustment interval. + start_date: + ); end sig do override .returns( @@ -422,10 +489,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -489,10 +563,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -556,10 +637,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -628,11 +716,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -697,10 +793,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -753,8 +856,20 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -798,10 +913,15 @@ module Orb .returns(T.attached_class) end def self.new( + # Only available if discount_type is `amount`. amount_discount:, + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, discount_type: :amount ); end @@ -858,10 +978,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. percentage_discount:, + # The start date of the discount interval. start_date:, discount_type: :percentage ); end @@ -918,10 +1044,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for usage_discount:, discount_type: :usage ); end @@ -1008,14 +1140,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this maximum interval applies to. applies_to_price_ids:, + # The price interval ids that this maximum interval applies to. applies_to_price_interval_ids:, + # The end date of the maximum interval. end_date:, + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. maximum_amount:, + # The start date of the maximum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1064,14 +1200,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this minimum interval applies to. applies_to_price_ids:, + # The price interval ids that this minimum interval applies to. applies_to_price_interval_ids:, + # The end date of the minimum interval. end_date:, + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. minimum_amount:, + # The start date of the minimum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1250,14 +1390,40 @@ module Orb end def self.new( id:, + # The day of the month that Orb bills for this price billing_cycle_day:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. current_billing_period_start_date:, + # The end date of the price interval. This is the date that Orb stops billing for + # this price. end_date:, + # An additional filter to apply to usage queries. filter:, + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. fixed_fee_quantity_transitions:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # The start date of the price interval. This is the date that Orb starts billing + # for this price. start_date:, + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. usage_customer_ids: ); end sig do @@ -1349,8 +1515,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCancelResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionCancelResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::SubscriptionCancelResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionCancelResponse::Status::TaggedSymbol) @@ -1400,8 +1565,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end - + def self.new( + # The credit notes that were created as part of this operation. + created_credit_notes:, + # The invoices that were created as part of this operation. + created_invoices:, + # The credit notes that were voided as part of this operation. + voided_credit_notes:, + # The invoices that were voided as part of this operation. + voided_invoices: + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_change_apply_params.rbi b/rbi/lib/orb/models/subscription_change_apply_params.rbi index 679feea8..07363c79 100644 --- a/rbi/lib/orb/models/subscription_change_apply_params.rbi +++ b/rbi/lib/orb/models/subscription_change_apply_params.rbi @@ -22,8 +22,13 @@ module Orb ) .returns(T.attached_class) end - def self.new(description: nil, previously_collected_amount: nil, request_options: {}); end - + def self.new( + # Description to apply to the balance transaction representing this credit. + description: nil, + # Amount already collected to apply to the customer's balance. + previously_collected_amount: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_change_apply_response.rbi b/rbi/lib/orb/models/subscription_change_apply_response.rbi index 0c78e7a4..ac33a6e7 100644 --- a/rbi/lib/orb/models/subscription_change_apply_response.rbi +++ b/rbi/lib/orb/models/subscription_change_apply_response.rbi @@ -47,8 +47,17 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil); end - + def self.new( + id:, + # Subscription change will be cancelled at this time and can no longer be applied. + expiration_time:, + status:, + subscription:, + # When this change was applied. + applied_at: nil, + # When this change was cancelled. + cancelled_at: nil + ); end sig do override .returns( @@ -68,8 +77,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionChangeApplyResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionChangeApplyResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PENDING = T.let(:pending, Orb::Models::SubscriptionChangeApplyResponse::Status::TaggedSymbol) APPLIED = T.let(:applied, Orb::Models::SubscriptionChangeApplyResponse::Status::TaggedSymbol) @@ -357,31 +365,90 @@ module Orb end def self.new( id:, + # The current plan phase that is active, only if the subscription's plan has + # phases. active_plan_phase_order:, + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. adjustment_intervals:, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. auto_collection:, billing_cycle_anchor_configuration:, + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. billing_cycle_day:, created_at:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. current_billing_period_start_date:, + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. customer:, + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo:, + # The discount intervals for this subscription sorted by the start_date. discount_intervals:, + # The date Orb stops billing for this subscription. end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, + # The maximum intervals for this subscription sorted by the start_date. maximum_intervals:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The minimum intervals for this subscription sorted by the start_date. minimum_intervals:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms:, + # A pending subscription change if one exists on this subscription. pending_subscription_change:, + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). plan:, + # The price intervals for this subscription. price_intervals:, redeemed_coupon:, + # The date Orb starts billing for this subscription. start_date:, status:, trial_info:, + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. changed_resources: nil ); end sig do @@ -472,8 +539,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end - + def self.new( + id:, + adjustment:, + # The price interval IDs that this adjustment applies to. + applies_to_price_interval_ids:, + # The end date of the adjustment interval. + end_date:, + # The start date of the adjustment interval. + start_date: + ); end sig do override .returns( @@ -540,10 +615,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -607,10 +689,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -674,10 +763,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -746,11 +842,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -815,10 +919,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -875,8 +986,20 @@ module Orb year: T.nilable(Integer) ).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -920,10 +1043,15 @@ module Orb .returns(T.attached_class) end def self.new( + # Only available if discount_type is `amount`. amount_discount:, + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, discount_type: :amount ); end @@ -980,10 +1108,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. percentage_discount:, + # The start date of the discount interval. start_date:, discount_type: :percentage ); end @@ -1040,10 +1174,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for usage_discount:, discount_type: :usage ); end @@ -1130,14 +1270,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this maximum interval applies to. applies_to_price_ids:, + # The price interval ids that this maximum interval applies to. applies_to_price_interval_ids:, + # The end date of the maximum interval. end_date:, + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. maximum_amount:, + # The start date of the maximum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1186,14 +1330,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this minimum interval applies to. applies_to_price_ids:, + # The price interval ids that this minimum interval applies to. applies_to_price_interval_ids:, + # The end date of the minimum interval. end_date:, + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. minimum_amount:, + # The start date of the minimum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1374,14 +1522,40 @@ module Orb end def self.new( id:, + # The day of the month that Orb bills for this price billing_cycle_day:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. current_billing_period_start_date:, + # The end date of the price interval. This is the date that Orb stops billing for + # this price. end_date:, + # An additional filter to apply to usage queries. filter:, + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. fixed_fee_quantity_transitions:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # The start date of the price interval. This is the date that Orb starts billing + # for this price. start_date:, + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. usage_customer_ids: ); end sig do @@ -1478,8 +1652,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status::TaggedSymbol) @@ -1533,8 +1706,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end - + def self.new( + # The credit notes that were created as part of this operation. + created_credit_notes:, + # The invoices that were created as part of this operation. + created_invoices:, + # The credit notes that were voided as part of this operation. + voided_credit_notes:, + # The invoices that were voided as part of this operation. + voided_invoices: + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_change_cancel_response.rbi b/rbi/lib/orb/models/subscription_change_cancel_response.rbi index 50a9e0f4..30ba32bf 100644 --- a/rbi/lib/orb/models/subscription_change_cancel_response.rbi +++ b/rbi/lib/orb/models/subscription_change_cancel_response.rbi @@ -47,8 +47,17 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil); end - + def self.new( + id:, + # Subscription change will be cancelled at this time and can no longer be applied. + expiration_time:, + status:, + subscription:, + # When this change was applied. + applied_at: nil, + # When this change was cancelled. + cancelled_at: nil + ); end sig do override .returns( @@ -68,8 +77,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionChangeCancelResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionChangeCancelResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PENDING = T.let(:pending, Orb::Models::SubscriptionChangeCancelResponse::Status::TaggedSymbol) APPLIED = T.let(:applied, Orb::Models::SubscriptionChangeCancelResponse::Status::TaggedSymbol) @@ -367,31 +375,90 @@ module Orb end def self.new( id:, + # The current plan phase that is active, only if the subscription's plan has + # phases. active_plan_phase_order:, + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. adjustment_intervals:, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. auto_collection:, billing_cycle_anchor_configuration:, + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. billing_cycle_day:, created_at:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. current_billing_period_start_date:, + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. customer:, + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo:, + # The discount intervals for this subscription sorted by the start_date. discount_intervals:, + # The date Orb stops billing for this subscription. end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, + # The maximum intervals for this subscription sorted by the start_date. maximum_intervals:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The minimum intervals for this subscription sorted by the start_date. minimum_intervals:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms:, + # A pending subscription change if one exists on this subscription. pending_subscription_change:, + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). plan:, + # The price intervals for this subscription. price_intervals:, redeemed_coupon:, + # The date Orb starts billing for this subscription. start_date:, status:, trial_info:, + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. changed_resources: nil ); end sig do @@ -482,8 +549,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end - + def self.new( + id:, + adjustment:, + # The price interval IDs that this adjustment applies to. + applies_to_price_interval_ids:, + # The end date of the adjustment interval. + end_date:, + # The start date of the adjustment interval. + start_date: + ); end sig do override .returns( @@ -550,10 +625,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -617,10 +699,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -684,10 +773,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -756,11 +852,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -825,10 +929,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -885,8 +996,20 @@ module Orb year: T.nilable(Integer) ).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -930,10 +1053,15 @@ module Orb .returns(T.attached_class) end def self.new( + # Only available if discount_type is `amount`. amount_discount:, + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, discount_type: :amount ); end @@ -990,10 +1118,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. percentage_discount:, + # The start date of the discount interval. start_date:, discount_type: :percentage ); end @@ -1050,10 +1184,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for usage_discount:, discount_type: :usage ); end @@ -1140,14 +1280,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this maximum interval applies to. applies_to_price_ids:, + # The price interval ids that this maximum interval applies to. applies_to_price_interval_ids:, + # The end date of the maximum interval. end_date:, + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. maximum_amount:, + # The start date of the maximum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1196,14 +1340,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this minimum interval applies to. applies_to_price_ids:, + # The price interval ids that this minimum interval applies to. applies_to_price_interval_ids:, + # The end date of the minimum interval. end_date:, + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. minimum_amount:, + # The start date of the minimum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1384,14 +1532,40 @@ module Orb end def self.new( id:, + # The day of the month that Orb bills for this price billing_cycle_day:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. current_billing_period_start_date:, + # The end date of the price interval. This is the date that Orb stops billing for + # this price. end_date:, + # An additional filter to apply to usage queries. filter:, + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. fixed_fee_quantity_transitions:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # The start date of the price interval. This is the date that Orb starts billing + # for this price. start_date:, + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. usage_customer_ids: ); end sig do @@ -1488,8 +1662,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status::TaggedSymbol) @@ -1544,8 +1717,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end - + def self.new( + # The credit notes that were created as part of this operation. + created_credit_notes:, + # The invoices that were created as part of this operation. + created_invoices:, + # The credit notes that were voided as part of this operation. + voided_credit_notes:, + # The invoices that were voided as part of this operation. + voided_invoices: + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_change_retrieve_response.rbi b/rbi/lib/orb/models/subscription_change_retrieve_response.rbi index f4576676..ff7ab7cb 100644 --- a/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +++ b/rbi/lib/orb/models/subscription_change_retrieve_response.rbi @@ -47,8 +47,17 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil); end - + def self.new( + id:, + # Subscription change will be cancelled at this time and can no longer be applied. + expiration_time:, + status:, + subscription:, + # When this change was applied. + applied_at: nil, + # When this change was cancelled. + cancelled_at: nil + ); end sig do override .returns( @@ -68,8 +77,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PENDING = T.let(:pending, Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol) APPLIED = T.let(:applied, Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol) @@ -382,31 +390,90 @@ module Orb end def self.new( id:, + # The current plan phase that is active, only if the subscription's plan has + # phases. active_plan_phase_order:, + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. adjustment_intervals:, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. auto_collection:, billing_cycle_anchor_configuration:, + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. billing_cycle_day:, created_at:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. current_billing_period_start_date:, + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. customer:, + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo:, + # The discount intervals for this subscription sorted by the start_date. discount_intervals:, + # The date Orb stops billing for this subscription. end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, + # The maximum intervals for this subscription sorted by the start_date. maximum_intervals:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The minimum intervals for this subscription sorted by the start_date. minimum_intervals:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms:, + # A pending subscription change if one exists on this subscription. pending_subscription_change:, + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). plan:, + # The price intervals for this subscription. price_intervals:, redeemed_coupon:, + # The date Orb starts billing for this subscription. start_date:, status:, trial_info:, + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. changed_resources: nil ); end sig do @@ -497,8 +564,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end - + def self.new( + id:, + adjustment:, + # The price interval IDs that this adjustment applies to. + applies_to_price_interval_ids:, + # The end date of the adjustment interval. + end_date:, + # The start date of the adjustment interval. + start_date: + ); end sig do override .returns( @@ -565,10 +640,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -632,10 +714,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -699,10 +788,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -771,11 +867,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -840,10 +944,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -900,8 +1011,20 @@ module Orb year: T.nilable(Integer) ).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -945,10 +1068,15 @@ module Orb .returns(T.attached_class) end def self.new( + # Only available if discount_type is `amount`. amount_discount:, + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, discount_type: :amount ); end @@ -1005,10 +1133,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. percentage_discount:, + # The start date of the discount interval. start_date:, discount_type: :percentage ); end @@ -1065,10 +1199,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for usage_discount:, discount_type: :usage ); end @@ -1155,14 +1295,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this maximum interval applies to. applies_to_price_ids:, + # The price interval ids that this maximum interval applies to. applies_to_price_interval_ids:, + # The end date of the maximum interval. end_date:, + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. maximum_amount:, + # The start date of the maximum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1211,14 +1355,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this minimum interval applies to. applies_to_price_ids:, + # The price interval ids that this minimum interval applies to. applies_to_price_interval_ids:, + # The end date of the minimum interval. end_date:, + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. minimum_amount:, + # The start date of the minimum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1399,14 +1547,40 @@ module Orb end def self.new( id:, + # The day of the month that Orb bills for this price billing_cycle_day:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. current_billing_period_start_date:, + # The end date of the price interval. This is the date that Orb stops billing for + # this price. end_date:, + # An additional filter to apply to usage queries. filter:, + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. fixed_fee_quantity_transitions:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # The start date of the price interval. This is the date that Orb starts billing + # for this price. start_date:, + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. usage_customer_ids: ); end sig do @@ -1503,8 +1677,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol) @@ -1560,8 +1733,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end - + def self.new( + # The credit notes that were created as part of this operation. + created_credit_notes:, + # The invoices that were created as part of this operation. + created_invoices:, + # The credit notes that were voided as part of this operation. + voided_credit_notes:, + # The invoices that were voided as part of this operation. + voided_invoices: + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_create_params.rbi b/rbi/lib/orb/models/subscription_create_params.rbi index db6ad2a6..381e6381 100644 --- a/rbi/lib/orb/models/subscription_create_params.rbi +++ b/rbi/lib/orb/models/subscription_create_params.rbi @@ -207,36 +207,87 @@ module Orb .returns(T.attached_class) end def self.new( + # Additional adjustments to be added to the subscription. (Only available for + # accounts that have migrated off of legacy subscription overrides) add_adjustments: nil, + # Additional prices to be added to the subscription. (Only available for accounts + # that have migrated off of legacy subscription overrides) add_prices: nil, align_billing_with_subscription_start_date: nil, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. If not specified, this + # defaults to the behavior configured for this customer. auto_collection: nil, aws_region: nil, billing_cycle_anchor_configuration: nil, + # Redemption code to be used for this subscription. If the coupon cannot be found + # by its redemption code, or cannot be redeemed, an error response will be + # returned and the subscription creation or plan change will not be scheduled. coupon_redemption_code: nil, credits_overage_rate: nil, customer_id: nil, + # Determines the default memo on this subscription's invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo: nil, end_date: nil, external_customer_id: nil, external_marketplace: nil, external_marketplace_reporting_id: nil, + # The external_plan_id of the plan that the given subscription should be switched + # to. Note that either this property or `plan_id` must be specified. external_plan_id: nil, + # An additional filter to apply to usage queries. This filter must be expressed as + # a boolean + # [computed property](/extensibility/advanced-metrics#computed-properties). If + # null, usage queries will not include any additional filter. filter: nil, + # The phase of the plan to start with initial_phase_order: nil, + # When this subscription's accrued usage reaches this threshold, an invoice will + # be issued for the subscription. If not specified, invoices will only be issued + # at the end of the billing period. invoicing_threshold: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # The net terms determines the difference between the invoice date and the issue + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. If not provided, this defaults to the value specified in the plan. net_terms: nil, per_credit_overage_amount: nil, + # The plan that the given subscription should be switched to. Note that either + # this property or `external_plan_id` must be specified. plan_id: nil, + # Specifies which version of the plan to subscribe to. If null, the default + # version will be used. plan_version_number: nil, + # Optionally provide a list of overrides for prices on the plan price_overrides: nil, + # Plan adjustments to be removed from the subscription. (Only available for + # accounts that have migrated off of legacy subscription overrides) remove_adjustments: nil, + # Plan prices to be removed from the subscription. (Only available for accounts + # that have migrated off of legacy subscription overrides) remove_prices: nil, + # Plan adjustments to be replaced with additional adjustments on the subscription. + # (Only available for accounts that have migrated off of legacy subscription + # overrides) replace_adjustments: nil, + # Plan prices to be replaced with additional prices on the subscription. (Only + # available for accounts that have migrated off of legacy subscription overrides) replace_prices: nil, start_date: nil, + # The duration of the trial period in days. If not provided, this defaults to the + # value specified in the plan. If `0` is provided, the trial on the plan will be + # skipped. trial_duration_days: nil, + # A list of customer IDs whose usage events will be aggregated and billed under + # this subscription. By default, a subscription only considers usage events + # associated with its attached customer's customer_id. When usage_customer_ids is + # provided, the subscription includes usage events from the specified customers + # only. Provided usage_customer_ids must be either the customer for this + # subscription itself, or any of that customer's children. usage_customer_ids: nil, request_options: {} ); end @@ -327,8 +378,19 @@ module Orb ) .returns(T.attached_class) end - def self.new(adjustment:, end_date: nil, plan_phase_order: nil, start_date: nil); end - + def self.new( + # The definition of a new adjustment to create and add to the subscription. + adjustment:, + # The end date of the adjustment interval. This is the date that the adjustment + # will stop affecting prices on the subscription. + end_date: nil, + # The phase to add this adjustment to. + plan_phase_order: nil, + # The start date of the adjustment interval. This is the date that the adjustment + # will start affecting prices on the subscription. If null, the adjustment will + # start when the phase or subscription starts. + start_date: nil + ); end sig do override .returns( @@ -381,13 +443,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, percentage_discount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -431,13 +494,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, usage_discount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -482,12 +546,13 @@ module Orb end def self.new( amount_discount:, + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -536,14 +601,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, + # The item ID that revenue from this minimum will be attributed to. item_id:, minimum_amount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -588,13 +655,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, maximum_amount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -754,15 +822,32 @@ module Orb .returns(T.attached_class) end def self.new( + # The definition of a new allocation price to create and add to the subscription. allocation_price: nil, + # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for this + # price. discounts: nil, + # The end date of the price interval. This is the date that the price will stop + # billing on the subscription. If null, billing will end when the phase or + # subscription ends. end_date: nil, + # The external price id of the price to add to the subscription. external_price_id: nil, + # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for + # this price. maximum_amount: nil, + # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for + # this price. minimum_amount: nil, + # The phase to add this price to. plan_phase_order: nil, + # The definition of a new price to create and add to the subscription. price: nil, + # The id of the price to add to the subscription. price_id: nil, + # The start date of the price interval. This is the date that the price will start + # billing on the subscription. If null, billing will start when the phase or + # subscription starts. start_date: nil ); end sig do @@ -841,8 +926,18 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:); end - + def self.new( + # An amount of the currency to allocate to the customer at the specified cadence. + amount:, + # The cadence at which to allocate the amount to the customer. + cadence:, + # An ISO 4217 currency string or a custom pricing unit identifier in which to bill + # this price. + currency:, + # Whether the allocated amount should expire at the end of the cadence or roll + # over to the next period. + expires_at_end_of_cadence: + ); end sig do override .returns( @@ -862,14 +957,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let(:one_time, Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::Cadence::TaggedSymbol) @@ -922,9 +1010,17 @@ module Orb ) .returns(T.attached_class) end - def self.new(discount_type:, amount_discount: nil, percentage_discount: nil, usage_discount: nil) - end - + def self.new( + discount_type:, + # Only available if discount_type is `amount`. + amount_discount: nil, + # Only available if discount_type is `percentage`. This is a number between 0 + # and 1. + percentage_discount: nil, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for + usage_discount: nil + ); end sig do override .returns( @@ -943,14 +1039,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Discount::DiscountType) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Discount::DiscountType::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } PERCENTAGE = T.let(:percentage, Orb::Models::SubscriptionCreateParams::AddPrice::Discount::DiscountType::TaggedSymbol) @@ -1131,20 +1220,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :unit ); end @@ -1183,14 +1295,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -1238,8 +1343,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:); end - + def self.new( + # Rate per unit of usage + unit_amount: + ); end sig { override.returns({unit_amount: String}) } def to_hash; end end @@ -1266,8 +1373,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1287,14 +1398,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1341,8 +1445,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1362,14 +1470,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1559,20 +1660,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, package_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :package ); end @@ -1613,14 +1737,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -1673,8 +1790,13 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:); end - + def self.new( + # A currency amount to rate usage by + package_amount:, + # An integer amount to represent package size. For example, 1000 here would divide + # usage by 1000 before multiplying by package_amount in rating + package_size: + ); end sig { override.returns({package_amount: String, package_size: Integer}) } def to_hash; end end @@ -1701,8 +1823,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1722,14 +1848,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1776,8 +1895,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1797,14 +1920,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1990,20 +2106,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, matrix_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :matrix ); end @@ -2042,14 +2181,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -2123,8 +2255,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:); end - + def self.new( + # Default per unit rate for any usage not bucketed into a specified matrix_value + default_unit_amount:, + # One or two event property values to evaluate matrix groups by + dimensions:, + # Matrix values for specified matrix grouping keys + matrix_values: + ); end sig do override .returns( @@ -2156,8 +2294,14 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:); end - + def self.new( + # One or two matrix keys to filter usage to this Matrix value by. For example, + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. + dimension_values:, + # Unit price for the specified dimension_values + unit_amount: + ); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } def to_hash; end end @@ -2185,8 +2329,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2206,14 +2354,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2260,8 +2401,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2281,14 +2426,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2474,20 +2612,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered ); end @@ -2526,14 +2687,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -2595,8 +2749,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for rating based on total usage quantities into the specified tier + tiers: + ); end sig do override .returns( @@ -2627,8 +2783,14 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil); end - + def self.new( + # Exclusive tier starting value + first_unit:, + # Amount per unit + unit_amount:, + # Inclusive tier ending value. If null, this is treated as the last tier + last_unit: nil + ); end sig do override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) end @@ -2658,8 +2820,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2679,14 +2845,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2733,8 +2892,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2754,14 +2917,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2951,20 +3107,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_bps_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_bps ); end @@ -3005,14 +3184,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -3079,8 +3251,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # tiers + tiers: + ); end sig do override .returns( @@ -3119,8 +3294,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Per-event basis point rate + bps:, + # Exclusive tier starting value + minimum_amount:, + # Inclusive tier ending value + maximum_amount: nil, + # Per unit maximum to charge + per_unit_maximum: nil + ); end sig do override .returns( @@ -3158,8 +3341,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3179,14 +3366,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3233,8 +3413,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3254,14 +3438,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3448,19 +3625,42 @@ module Orb end def self.new( bps_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bps ); end @@ -3503,8 +3703,12 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil); end - + def self.new( + # Basis point take rate per event + bps:, + # Optional currency amount maximum to cap spend per event + per_unit_maximum: nil + ); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } def to_hash; end end @@ -3515,14 +3719,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -3586,8 +3783,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3607,14 +3808,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3661,8 +3855,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3682,14 +3880,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3880,19 +4071,42 @@ module Orb end def self.new( bulk_bps_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bulk_bps ); end @@ -3946,8 +4160,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a bulk BPS pricing model where all usage is aggregated to a single + # tier based on total volume + tiers: + ); end sig do override .returns( @@ -3975,8 +4192,14 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Basis points to rate on + bps:, + # Upper bound for tier + maximum_amount: nil, + # The maximum amount to charge for any one event + per_unit_maximum: nil + ); end sig do override.returns( { @@ -3998,14 +4221,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -4069,8 +4285,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4090,14 +4310,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4144,8 +4357,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4165,14 +4382,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4359,19 +4569,42 @@ module Orb end def self.new( bulk_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bulk ); end @@ -4424,8 +4657,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Bulk tiers for rating based on total usage volume + tiers: + ); end sig do override .returns( @@ -4446,8 +4681,12 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil); end - + def self.new( + # Amount per unit + unit_amount:, + # Upper bound for this tier + maximum_units: nil + ); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } def to_hash; end end @@ -4459,14 +4698,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -4530,8 +4762,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4551,14 +4787,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4605,8 +4834,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4626,14 +4859,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4805,20 +5031,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, threshold_total_amount_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :threshold_total_amount ); end @@ -4859,14 +5108,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -4932,8 +5174,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4953,14 +5199,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5007,8 +5246,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5028,14 +5271,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5207,20 +5443,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_package_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_package ); end @@ -5261,14 +5520,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -5334,8 +5586,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5355,14 +5611,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5409,8 +5658,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5430,14 +5683,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5609,20 +5855,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_with_minimum_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_with_minimum ); end @@ -5663,14 +5932,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -5736,8 +5998,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5757,14 +6023,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5811,8 +6070,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5832,14 +6095,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6011,20 +6267,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_with_percent_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :unit_with_percent ); end @@ -6065,14 +6344,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -6138,8 +6410,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6159,14 +6435,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6213,8 +6482,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6234,14 +6507,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6413,20 +6679,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, package_with_allocation_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :package_with_allocation ); end @@ -6467,14 +6756,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -6540,8 +6822,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6561,14 +6847,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6615,8 +6894,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6636,14 +6919,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6815,20 +7091,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_with_proration_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_with_proration ); end @@ -6869,14 +7168,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -6942,8 +7234,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6963,14 +7259,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7017,8 +7306,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7038,14 +7331,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7217,20 +7503,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_with_proration_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :unit_with_proration ); end @@ -7271,14 +7580,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -7344,8 +7646,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7365,14 +7671,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7419,8 +7718,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7440,14 +7743,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7619,20 +7915,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_allocation_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_allocation ); end @@ -7673,14 +7992,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -7746,8 +8058,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7767,14 +8083,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7821,8 +8130,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7842,14 +8155,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8021,20 +8327,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_with_prorated_minimum_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_with_prorated_minimum ); end @@ -8075,14 +8404,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -8148,8 +8470,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8169,14 +8495,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8223,8 +8542,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8244,14 +8567,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8424,19 +8740,42 @@ module Orb end def self.new( bulk_with_proration_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bulk_with_proration ); end @@ -8477,14 +8816,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -8550,8 +8882,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8571,14 +8907,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8625,8 +8954,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8646,14 +8979,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8825,20 +9151,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, scalable_matrix_with_unit_pricing_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :scalable_matrix_with_unit_pricing ); end @@ -8879,14 +9228,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -8952,8 +9294,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8973,14 +9319,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9027,8 +9366,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9048,14 +9391,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9227,20 +9563,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, scalable_matrix_with_tiered_pricing_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :scalable_matrix_with_tiered_pricing ); end @@ -9281,14 +9640,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -9354,8 +9706,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9375,14 +9731,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9429,8 +9778,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9450,14 +9803,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9629,20 +9975,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, cumulative_grouped_bulk_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :cumulative_grouped_bulk ); end @@ -9683,14 +10052,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -9756,8 +10118,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9777,14 +10143,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9831,8 +10190,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9852,14 +10215,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10031,20 +10387,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, max_group_tiered_package_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :max_group_tiered_package ); end @@ -10085,14 +10464,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -10158,8 +10530,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10179,14 +10555,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10233,8 +10602,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10254,14 +10627,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10433,20 +10799,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_with_metered_minimum_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_with_metered_minimum ); end @@ -10487,14 +10876,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -10560,8 +10942,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10581,14 +10967,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10635,8 +11014,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10656,14 +11039,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10835,20 +11211,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, matrix_with_display_name_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :matrix_with_display_name ); end @@ -10889,14 +11288,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -10962,8 +11354,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10983,14 +11379,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11037,8 +11426,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -11058,14 +11451,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11237,20 +11623,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_tiered_package_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_tiered_package ); end @@ -11291,14 +11700,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -11364,8 +11766,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -11385,14 +11791,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11439,8 +11838,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -11460,14 +11863,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11525,8 +11921,20 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -11535,8 +11943,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::ExternalMarketplace) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionCreateParams::ExternalMarketplace::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } GOOGLE = T.let(:google, Orb::Models::SubscriptionCreateParams::ExternalMarketplace::TaggedSymbol) AWS = T.let(:aws, Orb::Models::SubscriptionCreateParams::ExternalMarketplace::TaggedSymbol) @@ -11552,8 +11959,10 @@ module Orb attr_accessor :adjustment_id sig { params(adjustment_id: String).returns(T.attached_class) } - def self.new(adjustment_id:); end - + def self.new( + # The id of the adjustment to remove on the subscription. + adjustment_id: + ); end sig { override.returns({adjustment_id: String}) } def to_hash; end end @@ -11570,8 +11979,12 @@ module Orb sig do params(external_price_id: T.nilable(String), price_id: T.nilable(String)).returns(T.attached_class) end - def self.new(external_price_id: nil, price_id: nil); end - + def self.new( + # The external price id of the price to remove on the subscription. + external_price_id: nil, + # The id of the price to remove on the subscription. + price_id: nil + ); end sig { override.returns({external_price_id: T.nilable(String), price_id: T.nilable(String)}) } def to_hash; end end @@ -11609,8 +12022,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(adjustment:, replaces_adjustment_id:); end - + def self.new( + # The definition of a new adjustment to create and add to the subscription. + adjustment:, + # The id of the adjustment on the plan to replace in the subscription. + replaces_adjustment_id: + ); end sig do override .returns( @@ -11661,13 +12078,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, percentage_discount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -11711,13 +12129,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, usage_discount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -11762,12 +12181,13 @@ module Orb end def self.new( amount_discount:, + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -11816,14 +12236,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, + # The item ID that revenue from this minimum will be attributed to. item_id:, minimum_amount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -11868,13 +12290,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, maximum_amount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -12029,14 +12452,26 @@ module Orb .returns(T.attached_class) end def self.new( + # The id of the price on the plan to replace in the subscription. replaces_price_id:, + # The definition of a new allocation price to create and add to the subscription. allocation_price: nil, + # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for the + # replacement price. discounts: nil, + # The external price id of the price to add to the subscription. external_price_id: nil, + # The new quantity of the price, if the price is a fixed price. fixed_price_quantity: nil, + # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for + # the replacement price. maximum_amount: nil, + # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for + # the replacement price. minimum_amount: nil, + # The definition of a new price to create and add to the subscription. price: nil, + # The id of the price to add to the subscription. price_id: nil ); end sig do @@ -12114,8 +12549,18 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:); end - + def self.new( + # An amount of the currency to allocate to the customer at the specified cadence. + amount:, + # The cadence at which to allocate the amount to the customer. + cadence:, + # An ISO 4217 currency string or a custom pricing unit identifier in which to bill + # this price. + currency:, + # Whether the allocated amount should expire at the end of the cadence or roll + # over to the next period. + expires_at_end_of_cadence: + ); end sig do override .returns( @@ -12135,14 +12580,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let( @@ -12212,9 +12650,17 @@ module Orb ) .returns(T.attached_class) end - def self.new(discount_type:, amount_discount: nil, percentage_discount: nil, usage_discount: nil) - end - + def self.new( + discount_type:, + # Only available if discount_type is `amount`. + amount_discount: nil, + # Only available if discount_type is `percentage`. This is a number between 0 + # and 1. + percentage_discount: nil, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for + usage_discount: nil + ); end sig do override .returns( @@ -12233,14 +12679,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Discount::DiscountType) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Discount::DiscountType::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } PERCENTAGE = T.let( @@ -12426,20 +12865,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :unit ); end @@ -12480,14 +12942,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -12537,8 +12992,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:); end - + def self.new( + # Rate per unit of usage + unit_amount: + ); end sig { override.returns({unit_amount: String}) } def to_hash; end end @@ -12565,8 +13022,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -12586,14 +13047,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -12640,8 +13094,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -12661,14 +13119,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -12858,20 +13309,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, package_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :package ); end @@ -12912,14 +13386,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -12974,8 +13441,13 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:); end - + def self.new( + # A currency amount to rate usage by + package_amount:, + # An integer amount to represent package size. For example, 1000 here would divide + # usage by 1000 before multiplying by package_amount in rating + package_size: + ); end sig { override.returns({package_amount: String, package_size: Integer}) } def to_hash; end end @@ -13002,8 +13474,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -13023,14 +13499,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -13077,8 +13546,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -13098,14 +13571,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -13295,20 +13761,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, matrix_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :matrix ); end @@ -13349,14 +13838,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -13432,8 +13914,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:); end - + def self.new( + # Default per unit rate for any usage not bucketed into a specified matrix_value + default_unit_amount:, + # One or two event property values to evaluate matrix groups by + dimensions:, + # Matrix values for specified matrix grouping keys + matrix_values: + ); end sig do override .returns( @@ -13465,8 +13953,14 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:); end - + def self.new( + # One or two matrix keys to filter usage to this Matrix value by. For example, + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. + dimension_values:, + # Unit price for the specified dimension_values + unit_amount: + ); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } def to_hash; end end @@ -13494,8 +13988,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -13515,14 +14013,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -13569,8 +14060,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -13590,14 +14085,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -13787,20 +14275,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered ); end @@ -13841,14 +14352,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -13912,8 +14416,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for rating based on total usage quantities into the specified tier + tiers: + ); end sig do override .returns( @@ -13944,8 +14450,14 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil); end - + def self.new( + # Exclusive tier starting value + first_unit:, + # Amount per unit + unit_amount:, + # Inclusive tier ending value. If null, this is treated as the last tier + last_unit: nil + ); end sig do override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) end @@ -13975,8 +14487,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -13996,14 +14512,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -14050,8 +14559,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -14071,14 +14584,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -14268,20 +14774,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_bps_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_bps ); end @@ -14322,14 +14851,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -14396,8 +14918,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # tiers + tiers: + ); end sig do override .returns( @@ -14436,8 +14961,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Per-event basis point rate + bps:, + # Exclusive tier starting value + minimum_amount:, + # Inclusive tier ending value + maximum_amount: nil, + # Per unit maximum to charge + per_unit_maximum: nil + ); end sig do override .returns( @@ -14475,8 +15008,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -14496,14 +15033,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -14550,8 +15080,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -14571,14 +15105,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -14765,19 +15292,42 @@ module Orb end def self.new( bps_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bps ); end @@ -14820,8 +15370,12 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil); end - + def self.new( + # Basis point take rate per event + bps:, + # Optional currency amount maximum to cap spend per event + per_unit_maximum: nil + ); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } def to_hash; end end @@ -14834,14 +15388,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -14905,8 +15452,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -14926,14 +15477,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -14980,8 +15524,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -15001,14 +15549,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -15199,19 +15740,42 @@ module Orb end def self.new( bulk_bps_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bulk_bps ); end @@ -15267,8 +15831,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a bulk BPS pricing model where all usage is aggregated to a single + # tier based on total volume + tiers: + ); end sig do override .returns( @@ -15298,8 +15865,14 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Basis points to rate on + bps:, + # Upper bound for tier + maximum_amount: nil, + # The maximum amount to charge for any one event + per_unit_maximum: nil + ); end sig do override.returns( { @@ -15321,14 +15894,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -15394,8 +15960,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -15415,14 +15985,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -15469,8 +16032,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -15490,14 +16057,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -15684,19 +16244,42 @@ module Orb end def self.new( bulk_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bulk ); end @@ -15749,8 +16332,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Bulk tiers for rating based on total usage volume + tiers: + ); end sig do override .returns( @@ -15771,8 +16356,12 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil); end - + def self.new( + # Amount per unit + unit_amount:, + # Upper bound for this tier + maximum_units: nil + ); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } def to_hash; end end @@ -15786,14 +16375,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -15859,8 +16441,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -15880,14 +16466,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -15934,8 +16513,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -15955,14 +16538,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -16134,20 +16710,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, threshold_total_amount_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :threshold_total_amount ); end @@ -16188,14 +16787,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -16261,8 +16853,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -16282,14 +16878,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -16336,8 +16925,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -16357,14 +16950,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -16536,20 +17122,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_package_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_package ); end @@ -16590,14 +17199,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -16663,8 +17265,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -16684,14 +17290,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -16738,8 +17337,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -16759,14 +17362,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -16938,20 +17534,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_with_minimum_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_with_minimum ); end @@ -16992,14 +17611,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -17065,8 +17677,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -17086,14 +17702,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -17140,8 +17749,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -17161,14 +17774,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -17340,20 +17946,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_with_percent_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :unit_with_percent ); end @@ -17394,14 +18023,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -17467,8 +18089,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -17488,14 +18114,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -17542,8 +18161,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -17563,14 +18186,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -17742,20 +18358,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, package_with_allocation_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :package_with_allocation ); end @@ -17796,14 +18435,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -17869,8 +18501,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -17890,14 +18526,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -17944,8 +18573,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -17965,14 +18598,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -18144,20 +18770,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_with_proration_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_with_proration ); end @@ -18198,14 +18847,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -18271,8 +18913,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -18292,14 +18938,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -18346,8 +18985,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -18367,14 +19010,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -18546,20 +19182,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_with_proration_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :unit_with_proration ); end @@ -18600,14 +19259,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -18673,8 +19325,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -18694,14 +19350,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -18748,8 +19397,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -18769,14 +19422,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -18948,20 +19594,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_allocation_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_allocation ); end @@ -19002,14 +19671,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -19075,8 +19737,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -19096,14 +19762,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -19150,8 +19809,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -19171,14 +19834,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -19350,20 +20006,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_with_prorated_minimum_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_with_prorated_minimum ); end @@ -19404,14 +20083,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -19477,8 +20149,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -19498,14 +20174,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -19552,8 +20221,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -19573,14 +20246,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -19753,19 +20419,42 @@ module Orb end def self.new( bulk_with_proration_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bulk_with_proration ); end @@ -19806,14 +20495,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -19879,8 +20561,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -19900,14 +20586,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -19954,8 +20633,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -19975,14 +20658,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -20154,20 +20830,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, scalable_matrix_with_unit_pricing_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :scalable_matrix_with_unit_pricing ); end @@ -20208,14 +20907,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -20281,8 +20973,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -20302,14 +20998,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -20356,8 +21045,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -20377,14 +21070,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -20556,20 +21242,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, scalable_matrix_with_tiered_pricing_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :scalable_matrix_with_tiered_pricing ); end @@ -20610,14 +21319,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -20683,8 +21385,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -20704,14 +21410,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -20758,8 +21457,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -20779,14 +21482,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -20958,20 +21654,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, cumulative_grouped_bulk_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :cumulative_grouped_bulk ); end @@ -21012,14 +21731,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -21085,8 +21797,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -21106,14 +21822,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -21160,8 +21869,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -21181,14 +21894,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -21360,20 +22066,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, max_group_tiered_package_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :max_group_tiered_package ); end @@ -21414,14 +22143,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -21487,8 +22209,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -21508,14 +22234,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -21562,8 +22281,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -21583,14 +22306,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -21762,20 +22478,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_with_metered_minimum_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_with_metered_minimum ); end @@ -21816,14 +22555,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -21889,8 +22621,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -21910,14 +22646,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -21964,8 +22693,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -21985,14 +22718,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -22164,20 +22890,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, matrix_with_display_name_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :matrix_with_display_name ); end @@ -22218,14 +22967,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -22291,8 +23033,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -22312,14 +23058,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -22366,8 +23105,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -22387,14 +23130,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -22566,20 +23302,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_tiered_package_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_tiered_package ); end @@ -22620,14 +23379,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -22693,8 +23445,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -22714,14 +23470,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -22768,8 +23517,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -22789,14 +23542,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( diff --git a/rbi/lib/orb/models/subscription_create_response.rbi b/rbi/lib/orb/models/subscription_create_response.rbi index f1ba0428..213128e0 100644 --- a/rbi/lib/orb/models/subscription_create_response.rbi +++ b/rbi/lib/orb/models/subscription_create_response.rbi @@ -239,31 +239,90 @@ module Orb end def self.new( id:, + # The current plan phase that is active, only if the subscription's plan has + # phases. active_plan_phase_order:, + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. adjustment_intervals:, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. auto_collection:, billing_cycle_anchor_configuration:, + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. billing_cycle_day:, created_at:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. current_billing_period_start_date:, + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. customer:, + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo:, + # The discount intervals for this subscription sorted by the start_date. discount_intervals:, + # The date Orb stops billing for this subscription. end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, + # The maximum intervals for this subscription sorted by the start_date. maximum_intervals:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The minimum intervals for this subscription sorted by the start_date. minimum_intervals:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms:, + # A pending subscription change if one exists on this subscription. pending_subscription_change:, + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). plan:, + # The price intervals for this subscription. price_intervals:, redeemed_coupon:, + # The date Orb starts billing for this subscription. start_date:, status:, trial_info:, + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. changed_resources: nil ); end sig do @@ -354,8 +413,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end - + def self.new( + id:, + adjustment:, + # The price interval IDs that this adjustment applies to. + applies_to_price_interval_ids:, + # The end date of the adjustment interval. + end_date:, + # The start date of the adjustment interval. + start_date: + ); end sig do override .returns( @@ -422,10 +489,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -489,10 +563,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -556,10 +637,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -628,11 +716,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -697,10 +793,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -753,8 +856,20 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -798,10 +913,15 @@ module Orb .returns(T.attached_class) end def self.new( + # Only available if discount_type is `amount`. amount_discount:, + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, discount_type: :amount ); end @@ -858,10 +978,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. percentage_discount:, + # The start date of the discount interval. start_date:, discount_type: :percentage ); end @@ -918,10 +1044,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for usage_discount:, discount_type: :usage ); end @@ -1008,14 +1140,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this maximum interval applies to. applies_to_price_ids:, + # The price interval ids that this maximum interval applies to. applies_to_price_interval_ids:, + # The end date of the maximum interval. end_date:, + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. maximum_amount:, + # The start date of the maximum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1064,14 +1200,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this minimum interval applies to. applies_to_price_ids:, + # The price interval ids that this minimum interval applies to. applies_to_price_interval_ids:, + # The end date of the minimum interval. end_date:, + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. minimum_amount:, + # The start date of the minimum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1250,14 +1390,40 @@ module Orb end def self.new( id:, + # The day of the month that Orb bills for this price billing_cycle_day:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. current_billing_period_start_date:, + # The end date of the price interval. This is the date that Orb stops billing for + # this price. end_date:, + # An additional filter to apply to usage queries. filter:, + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. fixed_fee_quantity_transitions:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # The start date of the price interval. This is the date that Orb starts billing + # for this price. start_date:, + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. usage_customer_ids: ); end sig do @@ -1349,8 +1515,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionCreateResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::SubscriptionCreateResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionCreateResponse::Status::TaggedSymbol) @@ -1400,8 +1565,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end - + def self.new( + # The credit notes that were created as part of this operation. + created_credit_notes:, + # The invoices that were created as part of this operation. + created_invoices:, + # The credit notes that were voided as part of this operation. + voided_credit_notes:, + # The invoices that were voided as part of this operation. + voided_invoices: + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_fetch_costs_params.rbi b/rbi/lib/orb/models/subscription_fetch_costs_params.rbi index 58fb4b0d..12f51bce 100644 --- a/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +++ b/rbi/lib/orb/models/subscription_fetch_costs_params.rbi @@ -36,14 +36,19 @@ module Orb .returns(T.attached_class) end def self.new( + # The currency or custom pricing unit to use. currency: nil, + # Costs returned are exclusive of `timeframe_end`. timeframe_end: nil, + # Costs returned are inclusive of `timeframe_start`. timeframe_start: nil, + # Controls whether Orb returns cumulative costs since the start of the billing + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. view_mode: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -66,8 +71,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PERIODIC = T.let(:periodic, Orb::Models::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol) CUMULATIVE = T.let(:cumulative, Orb::Models::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_fetch_costs_response.rbi b/rbi/lib/orb/models/subscription_fetch_costs_response.rbi index d2882a03..46885d9a 100644 --- a/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +++ b/rbi/lib/orb/models/subscription_fetch_costs_response.rbi @@ -43,8 +43,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:); end - + def self.new( + per_price_costs:, + # Total costs for the timeframe, excluding any minimums and discounts. + subtotal:, + timeframe_end:, + timeframe_start:, + # Total costs for the timeframe, including any minimums and discounts. + total: + ); end sig do override .returns( @@ -153,8 +160,18 @@ module Orb ) .returns(T.attached_class) end - def self.new(price:, price_id:, subtotal:, total:, quantity: nil); end - + def self.new( + # The price object + price:, + # The price the cost is associated with + price_id:, + # Price's contributions for the timeframe, excluding any minimums and discounts. + subtotal:, + # Price's contributions for the timeframe, including minimums and discounts. + total:, + # The price's quantity for the timeframe + quantity: nil + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi b/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi index fb67404c..95db768e 100644 --- a/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +++ b/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi @@ -43,7 +43,10 @@ module Orb .returns(T.attached_class) end def self.new( + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. cursor: nil, + # The number of items to fetch. Defaults to 20. limit: nil, start_date_gt: nil, start_date_gte: nil, diff --git a/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi b/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi index faa892fa..449285e7 100644 --- a/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +++ b/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi @@ -59,8 +59,14 @@ module Orb params(id: T.nilable(String), external_plan_id: T.nilable(String), name: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, external_plan_id:, name:); end - + def self.new( + id:, + # An optional user-defined ID for this plan resource, used throughout the system + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. + external_plan_id:, + name: + ); end sig do override.returns( { diff --git a/rbi/lib/orb/models/subscription_fetch_usage_params.rbi b/rbi/lib/orb/models/subscription_fetch_usage_params.rbi index 8fe150c2..2d5a6ee5 100644 --- a/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +++ b/rbi/lib/orb/models/subscription_fetch_usage_params.rbi @@ -64,15 +64,26 @@ module Orb .returns(T.attached_class) end def self.new( + # When specified in conjunction with `group_by`, this parameter filters usage to a + # single billable metric. Note that both `group_by` and `billable_metric_id` must + # be specified together. billable_metric_id: nil, first_dimension_key: nil, first_dimension_value: nil, + # This determines the windowing of usage reporting. granularity: nil, + # Groups per-price usage by the key provided. group_by: nil, second_dimension_key: nil, second_dimension_value: nil, + # Usage returned is exclusive of `timeframe_end`. timeframe_end: nil, + # Usage returned is inclusive of `timeframe_start`. timeframe_start: nil, + # Controls whether Orb returns cumulative usage since the start of the billing + # period, or incremental day-by-day usage. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. view_mode: nil, request_options: {} ); end @@ -101,8 +112,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionFetchUsageParams::Granularity) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionFetchUsageParams::Granularity::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let(:day, Orb::Models::SubscriptionFetchUsageParams::Granularity::TaggedSymbol) @@ -118,8 +128,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionFetchUsageParams::ViewMode::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PERIODIC = T.let(:periodic, Orb::Models::SubscriptionFetchUsageParams::ViewMode::TaggedSymbol) CUMULATIVE = T.let(:cumulative, Orb::Models::SubscriptionFetchUsageParams::ViewMode::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_list_params.rbi b/rbi/lib/orb/models/subscription_list_params.rbi index ccabb3f2..8a61ed18 100644 --- a/rbi/lib/orb/models/subscription_list_params.rbi +++ b/rbi/lib/orb/models/subscription_list_params.rbi @@ -59,9 +59,12 @@ module Orb created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, + # Cursor for pagination. This can be populated by the `next_cursor` value returned + # from the initial request. cursor: nil, customer_id: nil, external_customer_id: nil, + # The number of items to fetch. Defaults to 20. limit: nil, status: nil, request_options: {} @@ -89,8 +92,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionListParams::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionListParams::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::SubscriptionListParams::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionListParams::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_price_intervals_params.rbi b/rbi/lib/orb/models/subscription_price_intervals_params.rbi index 82716f0b..6a517884 100644 --- a/rbi/lib/orb/models/subscription_price_intervals_params.rbi +++ b/rbi/lib/orb/models/subscription_price_intervals_params.rbi @@ -68,10 +68,17 @@ module Orb .returns(T.attached_class) end def self.new( + # A list of price intervals to add to the subscription. add: nil, + # A list of adjustments to add to the subscription. add_adjustments: nil, + # If false, this request will fail if it would void an issued invoice or create a + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. allow_invoice_credit_or_void: nil, + # A list of price intervals to edit on the subscription. edit: nil, + # A list of adjustments to edit on the subscription. edit_adjustments: nil, request_options: {} ); end @@ -280,17 +287,41 @@ module Orb .returns(T.attached_class) end def self.new( + # The start date of the price interval. This is the date that the price will start + # billing on the subscription. start_date:, + # The definition of a new allocation price to create and add to the subscription. allocation_price: nil, + # A list of discounts to initialize on the price interval. discounts: nil, + # The end date of the price interval. This is the date that the price will stop + # billing on the subscription. end_date: nil, + # The external price id of the price to add to the subscription. external_price_id: nil, + # An additional filter to apply to usage queries. This filter must be expressed as + # a boolean + # [computed property](/extensibility/advanced-metrics#computed-properties). If + # null, usage queries will not include any additional filter. filter: nil, + # A list of fixed fee quantity transitions to initialize on the price interval. fixed_fee_quantity_transitions: nil, + # The maximum amount that will be billed for this price interval for a given + # billing period. maximum_amount: nil, + # The minimum amount that will be billed for this price interval for a given + # billing period. minimum_amount: nil, + # The definition of a new price to create and add to the subscription. price: nil, + # The id of the price to add to the subscription. price_id: nil, + # A list of customer IDs whose usage events will be aggregated and billed under + # this subscription. By default, a subscription only considers usage events + # associated with its attached customer's customer_id. When usage_customer_ids is + # provided, the subscription includes usage events from the specified customers + # only. Provided usage_customer_ids must be either the customer for this + # subscription itself, or any of that customer's children. usage_customer_ids: nil ); end sig do @@ -358,7 +389,7 @@ module Orb module StartDate extend Orb::Internal::Type::Union - sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } + sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) } def self.variants; end end @@ -391,8 +422,18 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:); end - + def self.new( + # An amount of the currency to allocate to the customer at the specified cadence. + amount:, + # The cadence at which to allocate the amount to the customer. + cadence:, + # An ISO 4217 currency string or a custom pricing unit identifier in which to bill + # this price. + currency:, + # Whether the allocated amount should expire at the end of the cadence or roll + # over to the next period. + expires_at_end_of_cadence: + ); end sig do override .returns( @@ -412,14 +453,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let( @@ -468,8 +502,11 @@ module Orb attr_accessor :discount_type sig { params(amount_discount: Float, discount_type: Symbol).returns(T.attached_class) } - def self.new(amount_discount:, discount_type: :amount); end - + def self.new( + # Only available if discount_type is `amount`. + amount_discount:, + discount_type: :amount + ); end sig { override.returns({amount_discount: Float, discount_type: Symbol}) } def to_hash; end end @@ -484,8 +521,12 @@ module Orb attr_accessor :percentage_discount sig { params(percentage_discount: Float, discount_type: Symbol).returns(T.attached_class) } - def self.new(percentage_discount:, discount_type: :percentage); end - + def self.new( + # Only available if discount_type is `percentage`. This is a number between 0 + # and 1. + percentage_discount:, + discount_type: :percentage + ); end sig { override.returns({discount_type: Symbol, percentage_discount: Float}) } def to_hash; end end @@ -500,8 +541,12 @@ module Orb attr_accessor :usage_discount sig { params(usage_discount: Float, discount_type: Symbol).returns(T.attached_class) } - def self.new(usage_discount:, discount_type: :usage); end - + def self.new( + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for. + usage_discount:, + discount_type: :usage + ); end sig { override.returns({discount_type: Symbol, usage_discount: Float}) } def to_hash; end end @@ -520,7 +565,7 @@ module Orb module EndDate extend Orb::Internal::Type::Union - sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } + sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) } def self.variants; end end @@ -534,8 +579,12 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, quantity:); end - + def self.new( + # The date that the fixed fee quantity transition should take effect. + effective_date:, + # The quantity of the fixed fee quantity transition. + quantity: + ); end sig { override.returns({effective_date: Time, quantity: Integer}) } def to_hash; end end @@ -697,19 +746,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :unit ); end @@ -747,14 +816,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -802,8 +864,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:); end - + def self.new( + # Rate per unit of usage + unit_amount: + ); end sig { override.returns({unit_amount: String}) } def to_hash; end end @@ -830,8 +894,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -851,14 +919,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -905,8 +966,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -926,14 +991,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1112,19 +1170,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, package_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :package ); end @@ -1162,14 +1240,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -1222,8 +1293,13 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:); end - + def self.new( + # A currency amount to rate usage by + package_amount:, + # An integer amount to represent package size. For example, 1000 here would divide + # usage by 1000 before multiplying by package_amount in rating + package_size: + ); end sig { override.returns({package_amount: String, package_size: Integer}) } def to_hash; end end @@ -1250,8 +1326,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1271,14 +1351,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1325,8 +1398,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1346,14 +1423,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1532,19 +1602,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, matrix_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :matrix ); end @@ -1582,14 +1672,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -1663,8 +1746,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:); end - + def self.new( + # Default per unit rate for any usage not bucketed into a specified matrix_value + default_unit_amount:, + # One or two event property values to evaluate matrix groups by + dimensions:, + # Matrix values for specified matrix grouping keys + matrix_values: + ); end sig do override .returns( @@ -1696,8 +1785,14 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:); end - + def self.new( + # One or two matrix keys to filter usage to this Matrix value by. For example, + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. + dimension_values:, + # Unit price for the specified dimension_values + unit_amount: + ); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } def to_hash; end end @@ -1725,8 +1820,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1746,14 +1845,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1800,8 +1892,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1821,14 +1917,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2011,19 +2100,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, matrix_with_allocation_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :matrix_with_allocation ); end @@ -2063,14 +2172,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -2151,8 +2253,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(allocation:, default_unit_amount:, dimensions:, matrix_values:); end - + def self.new( + # Allocation to be used to calculate the price + allocation:, + # Default per unit rate for any usage not bucketed into a specified matrix_value + default_unit_amount:, + # One or two event property values to evaluate matrix groups by + dimensions:, + # Matrix values for specified matrix grouping keys + matrix_values: + ); end sig do override .returns( @@ -2185,8 +2295,14 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:); end - + def self.new( + # One or two matrix keys to filter usage to this Matrix value by. For example, + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. + dimension_values:, + # Unit price for the specified dimension_values + unit_amount: + ); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } def to_hash; end end @@ -2214,8 +2330,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2235,14 +2355,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2289,8 +2402,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2310,14 +2427,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2496,19 +2606,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :tiered ); end @@ -2546,14 +2676,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -2615,8 +2738,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for rating based on total usage quantities into the specified tier + tiers: + ); end sig do override .returns( @@ -2647,8 +2772,14 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil); end - + def self.new( + # Exclusive tier starting value + first_unit:, + # Amount per unit + unit_amount:, + # Inclusive tier ending value. If null, this is treated as the last tier + last_unit: nil + ); end sig do override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) end @@ -2678,8 +2809,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2699,14 +2834,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2753,8 +2881,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2774,14 +2906,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2964,19 +3089,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_bps_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :tiered_bps ); end @@ -3016,14 +3161,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -3090,8 +3228,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # tiers + tiers: + ); end sig do override .returns( @@ -3130,8 +3271,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Per-event basis point rate + bps:, + # Exclusive tier starting value + minimum_amount:, + # Inclusive tier ending value + maximum_amount: nil, + # Per unit maximum to charge + per_unit_maximum: nil + ); end sig do override .returns( @@ -3169,8 +3318,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3190,14 +3343,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3244,8 +3390,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3265,14 +3415,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3448,18 +3591,38 @@ module Orb end def self.new( bps_config:, + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :bps ); end @@ -3501,8 +3664,12 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil); end - + def self.new( + # Basis point take rate per event + bps:, + # Optional currency amount maximum to cap spend per event + per_unit_maximum: nil + ); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } def to_hash; end end @@ -3513,14 +3680,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -3584,8 +3744,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3605,14 +3769,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3659,8 +3816,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3680,14 +3841,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3867,18 +4021,38 @@ module Orb end def self.new( bulk_bps_config:, + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :bulk_bps ); end @@ -3931,8 +4105,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a bulk BPS pricing model where all usage is aggregated to a single + # tier based on total volume + tiers: + ); end sig do override .returns( @@ -3960,8 +4137,14 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Basis points to rate on + bps:, + # Upper bound for tier + maximum_amount: nil, + # The maximum amount to charge for any one event + per_unit_maximum: nil + ); end sig do override.returns( { @@ -3981,14 +4164,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -4052,8 +4228,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4073,14 +4253,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4127,8 +4300,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4148,14 +4325,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4335,18 +4505,38 @@ module Orb end def self.new( bulk_config:, + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :bulk ); end @@ -4398,8 +4588,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Bulk tiers for rating based on total usage volume + tiers: + ); end sig do override .returns( @@ -4420,8 +4612,12 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil); end - + def self.new( + # Amount per unit + unit_amount:, + # Upper bound for this tier + maximum_units: nil + ); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } def to_hash; end end @@ -4433,14 +4629,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -4504,8 +4693,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4525,14 +4718,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4579,8 +4765,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4600,14 +4790,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4772,19 +4955,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, threshold_total_amount_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :threshold_total_amount ); end @@ -4824,14 +5027,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -4897,8 +5093,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4918,14 +5118,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4972,8 +5165,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4993,14 +5190,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5165,19 +5355,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_package_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :tiered_package ); end @@ -5217,14 +5427,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -5290,8 +5493,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5311,14 +5518,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5365,8 +5565,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5386,14 +5590,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5558,19 +5755,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, grouped_tiered_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :grouped_tiered ); end @@ -5610,14 +5827,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -5683,8 +5893,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5704,14 +5918,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5758,8 +5965,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5779,14 +5990,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5951,19 +6155,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, max_group_tiered_package_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :max_group_tiered_package ); end @@ -6003,14 +6227,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -6076,8 +6293,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6097,14 +6318,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6151,8 +6365,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6172,14 +6390,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6344,19 +6555,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_with_minimum_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :tiered_with_minimum ); end @@ -6396,14 +6627,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -6469,8 +6693,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6490,14 +6718,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6544,8 +6765,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6565,14 +6790,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6737,19 +6955,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, package_with_allocation_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :package_with_allocation ); end @@ -6789,14 +7027,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -6862,8 +7093,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6883,14 +7118,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6937,8 +7165,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6958,14 +7190,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7130,19 +7355,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_package_with_minimum_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :tiered_package_with_minimum ); end @@ -7182,14 +7427,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -7255,8 +7493,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7276,14 +7518,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7330,8 +7565,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7351,14 +7590,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7523,19 +7755,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_with_percent_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :unit_with_percent ); end @@ -7575,14 +7827,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -7648,8 +7893,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7669,14 +7918,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7723,8 +7965,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7744,14 +7990,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7916,19 +8155,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_with_proration_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :tiered_with_proration ); end @@ -7968,14 +8227,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -8041,8 +8293,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8062,14 +8318,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8116,8 +8365,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8137,14 +8390,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8309,19 +8555,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_with_proration_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :unit_with_proration ); end @@ -8361,14 +8627,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -8434,8 +8693,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8455,14 +8718,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8509,8 +8765,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8530,14 +8790,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8702,19 +8955,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, grouped_allocation_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :grouped_allocation ); end @@ -8754,14 +9027,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -8827,8 +9093,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8848,14 +9118,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8902,8 +9165,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8923,14 +9190,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9095,19 +9355,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, grouped_with_prorated_minimum_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :grouped_with_prorated_minimum ); end @@ -9147,14 +9427,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -9220,8 +9493,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9241,14 +9518,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9295,8 +9565,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9316,14 +9590,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9488,19 +9755,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, grouped_with_metered_minimum_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :grouped_with_metered_minimum ); end @@ -9540,14 +9827,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -9613,8 +9893,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9634,14 +9918,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9688,8 +9965,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9709,14 +9990,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9881,19 +10155,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, matrix_with_display_name_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :matrix_with_display_name ); end @@ -9933,14 +10227,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -10006,8 +10293,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10027,14 +10318,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10081,8 +10365,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10102,14 +10390,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10275,18 +10556,38 @@ module Orb end def self.new( bulk_with_proration_config:, + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :bulk_with_proration ); end @@ -10326,14 +10627,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -10399,8 +10693,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10420,14 +10718,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10474,8 +10765,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10495,14 +10790,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10667,19 +10955,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, grouped_tiered_package_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :grouped_tiered_package ); end @@ -10719,14 +11027,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -10792,8 +11093,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10813,14 +11118,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10867,8 +11165,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10888,14 +11190,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11060,19 +11355,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, scalable_matrix_with_unit_pricing_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :scalable_matrix_with_unit_pricing ); end @@ -11112,14 +11427,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -11185,8 +11493,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -11206,14 +11518,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11260,8 +11565,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -11281,14 +11590,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11453,19 +11755,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, scalable_matrix_with_tiered_pricing_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :scalable_matrix_with_tiered_pricing ); end @@ -11505,14 +11827,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -11578,8 +11893,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -11599,14 +11918,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11653,8 +11965,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -11674,14 +11990,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11846,19 +12155,39 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, cumulative_grouped_bulk_config:, + # An ISO 4217 currency string for which this price is billed in. currency:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, model_type: :cumulative_grouped_bulk ); end @@ -11898,14 +12227,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -11971,8 +12293,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -11992,14 +12318,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -12046,8 +12365,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -12067,14 +12390,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -12154,8 +12470,20 @@ module Orb ) .returns(T.attached_class) end - def self.new(adjustment:, start_date:, end_date: nil); end - + def self.new( + # The definition of a new adjustment to create and add to the subscription. + adjustment:, + # The start date of the adjustment interval. This is the date that the adjustment + # will start affecting prices on the subscription. The adjustment will apply to + # invoice dates that overlap with this `start_date`. This `start_date` is treated + # as inclusive for in-advance prices, and exclusive for in-arrears prices. + start_date:, + # The end date of the adjustment interval. This is the date that the adjustment + # will stop affecting prices on the subscription. The adjustment will apply to + # invoice dates that overlap with this `end_date`.This `end_date` is treated as + # exclusive for in-advance prices, and inclusive for in-arrears prices. + end_date: nil + ); end sig do override .returns( @@ -12207,13 +12535,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, percentage_discount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -12257,13 +12586,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, usage_discount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -12308,12 +12638,13 @@ module Orb end def self.new( amount_discount:, + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -12362,14 +12693,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, + # The item ID that revenue from this minimum will be attributed to. item_id:, minimum_amount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -12414,13 +12747,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, maximum_amount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -12451,7 +12785,7 @@ module Orb module StartDate extend Orb::Internal::Type::Union - sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } + sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) } def self.variants; end end @@ -12462,7 +12796,7 @@ module Orb module EndDate extend Orb::Internal::Type::Union - sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } + sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) } def self.variants; end end end @@ -12537,12 +12871,33 @@ module Orb .returns(T.attached_class) end def self.new( + # The id of the price interval to edit. price_interval_id:, + # The updated billing cycle day for this price interval. If not specified, the + # billing cycle day will not be updated. Note that overlapping price intervals + # must have the same billing cycle day. billing_cycle_day: nil, + # The updated end date of this price interval. If not specified, the start date + # will not be updated. end_date: nil, + # An additional filter to apply to usage queries. This filter must be expressed as + # a boolean + # [computed property](/extensibility/advanced-metrics#computed-properties). If + # null, usage queries will not include any additional filter. filter: nil, + # A list of fixed fee quantity transitions to use for this price interval. Note + # that this list will overwrite all existing fixed fee quantity transitions on the + # price interval. fixed_fee_quantity_transitions: nil, + # The updated start date of this price interval. If not specified, the start date + # will not be updated. start_date: nil, + # A list of customer IDs whose usage events will be aggregated and billed under + # this subscription. By default, a subscription only considers usage events + # associated with its attached customer's customer_id. When usage_customer_ids is + # provided, the subscription includes usage events from the specified customers + # only. Provided usage_customer_ids must be either the customer for this + # subscription itself, or any of that customer's children. usage_customer_ids: nil ); end sig do @@ -12566,7 +12921,7 @@ module Orb module EndDate extend Orb::Internal::Type::Union - sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } + sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) } def self.variants; end end @@ -12580,8 +12935,12 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, quantity:); end - + def self.new( + # The date that the fixed fee quantity transition should take effect. + effective_date:, + # The quantity of the fixed fee quantity transition. + quantity: + ); end sig { override.returns({effective_date: Time, quantity: Integer}) } def to_hash; end end @@ -12591,7 +12950,7 @@ module Orb module StartDate extend Orb::Internal::Type::Union - sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } + sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) } def self.variants; end end end @@ -12622,8 +12981,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(adjustment_interval_id:, end_date: nil, start_date: nil); end - + def self.new( + # The id of the adjustment interval to edit. + adjustment_interval_id:, + # The updated end date of this adjustment interval. If not specified, the start + # date will not be updated. + end_date: nil, + # The updated start date of this adjustment interval. If not specified, the start + # date will not be updated. + start_date: nil + ); end sig do override .returns( @@ -12641,7 +13008,7 @@ module Orb module EndDate extend Orb::Internal::Type::Union - sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } + sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) } def self.variants; end end @@ -12650,7 +13017,7 @@ module Orb module StartDate extend Orb::Internal::Type::Union - sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } + sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) } def self.variants; end end end diff --git a/rbi/lib/orb/models/subscription_price_intervals_response.rbi b/rbi/lib/orb/models/subscription_price_intervals_response.rbi index 6552034c..91efbcef 100644 --- a/rbi/lib/orb/models/subscription_price_intervals_response.rbi +++ b/rbi/lib/orb/models/subscription_price_intervals_response.rbi @@ -254,31 +254,90 @@ module Orb end def self.new( id:, + # The current plan phase that is active, only if the subscription's plan has + # phases. active_plan_phase_order:, + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. adjustment_intervals:, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. auto_collection:, billing_cycle_anchor_configuration:, + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. billing_cycle_day:, created_at:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. current_billing_period_start_date:, + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. customer:, + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo:, + # The discount intervals for this subscription sorted by the start_date. discount_intervals:, + # The date Orb stops billing for this subscription. end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, + # The maximum intervals for this subscription sorted by the start_date. maximum_intervals:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The minimum intervals for this subscription sorted by the start_date. minimum_intervals:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms:, + # A pending subscription change if one exists on this subscription. pending_subscription_change:, + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). plan:, + # The price intervals for this subscription. price_intervals:, redeemed_coupon:, + # The date Orb starts billing for this subscription. start_date:, status:, trial_info:, + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. changed_resources: nil ); end sig do @@ -369,8 +428,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end - + def self.new( + id:, + adjustment:, + # The price interval IDs that this adjustment applies to. + applies_to_price_interval_ids:, + # The end date of the adjustment interval. + end_date:, + # The start date of the adjustment interval. + start_date: + ); end sig do override .returns( @@ -437,10 +504,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -504,10 +578,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -571,10 +652,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -643,11 +731,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -712,10 +808,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -768,8 +871,20 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -813,10 +928,15 @@ module Orb .returns(T.attached_class) end def self.new( + # Only available if discount_type is `amount`. amount_discount:, + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, discount_type: :amount ); end @@ -873,10 +993,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. percentage_discount:, + # The start date of the discount interval. start_date:, discount_type: :percentage ); end @@ -933,10 +1059,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for usage_discount:, discount_type: :usage ); end @@ -1023,14 +1155,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this maximum interval applies to. applies_to_price_ids:, + # The price interval ids that this maximum interval applies to. applies_to_price_interval_ids:, + # The end date of the maximum interval. end_date:, + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. maximum_amount:, + # The start date of the maximum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1079,14 +1215,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this minimum interval applies to. applies_to_price_ids:, + # The price interval ids that this minimum interval applies to. applies_to_price_interval_ids:, + # The end date of the minimum interval. end_date:, + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. minimum_amount:, + # The start date of the minimum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1267,14 +1407,40 @@ module Orb end def self.new( id:, + # The day of the month that Orb bills for this price billing_cycle_day:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. current_billing_period_start_date:, + # The end date of the price interval. This is the date that Orb stops billing for + # this price. end_date:, + # An additional filter to apply to usage queries. filter:, + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. fixed_fee_quantity_transitions:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # The start date of the price interval. This is the date that Orb starts billing + # for this price. start_date:, + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. usage_customer_ids: ); end sig do @@ -1368,8 +1534,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol) @@ -1419,8 +1584,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end - + def self.new( + # The credit notes that were created as part of this operation. + created_credit_notes:, + # The invoices that were created as part of this operation. + created_invoices:, + # The credit notes that were voided as part of this operation. + voided_credit_notes:, + # The invoices that were voided as part of this operation. + voided_invoices: + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi b/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi index f2b807e1..4cc19c08 100644 --- a/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +++ b/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi @@ -204,30 +204,86 @@ module Orb end def self.new( change_option:, + # Additional adjustments to be added to the subscription. (Only available for + # accounts that have migrated off of legacy subscription overrides) add_adjustments: nil, + # Additional prices to be added to the subscription. (Only available for accounts + # that have migrated off of legacy subscription overrides) add_prices: nil, + # [DEPRECATED] Use billing_cycle_alignment instead. Reset billing periods to be + # aligned with the plan change's effective date. align_billing_with_plan_change_date: nil, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. If not specified, this + # defaults to the behavior configured for this customer. auto_collection: nil, + # Reset billing periods to be aligned with the plan change's effective date or + # start of the month. Defaults to `unchanged` which keeps subscription's existing + # billing cycle alignment. billing_cycle_alignment: nil, billing_cycle_anchor_configuration: nil, + # The date that the plan change should take effect. This parameter can only be + # passed if the `change_option` is `requested_date`. If a date with no time is + # passed, the plan change will happen at midnight in the customer's timezone. change_date: nil, + # Redemption code to be used for this subscription. If the coupon cannot be found + # by its redemption code, or cannot be redeemed, an error response will be + # returned and the subscription creation or plan change will not be scheduled. coupon_redemption_code: nil, credits_overage_rate: nil, + # Determines the default memo on this subscription's invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo: nil, + # The external_plan_id of the plan that the given subscription should be switched + # to. Note that either this property or `plan_id` must be specified. external_plan_id: nil, + # An additional filter to apply to usage queries. This filter must be expressed as + # a boolean + # [computed property](/extensibility/advanced-metrics#computed-properties). If + # null, usage queries will not include any additional filter. filter: nil, + # The phase of the plan to start with initial_phase_order: nil, + # When this subscription's accrued usage reaches this threshold, an invoice will + # be issued for the subscription. If not specified, invoices will only be issued + # at the end of the billing period. invoicing_threshold: nil, + # The net terms determines the difference between the invoice date and the issue + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. If not provided, this defaults to the value specified in the plan. net_terms: nil, per_credit_overage_amount: nil, + # The plan that the given subscription should be switched to. Note that either + # this property or `external_plan_id` must be specified. plan_id: nil, + # Specifies which version of the plan to change to. If null, the default version + # will be used. plan_version_number: nil, + # Optionally provide a list of overrides for prices on the plan price_overrides: nil, + # Plan adjustments to be removed from the subscription. (Only available for + # accounts that have migrated off of legacy subscription overrides) remove_adjustments: nil, + # Plan prices to be removed from the subscription. (Only available for accounts + # that have migrated off of legacy subscription overrides) remove_prices: nil, + # Plan adjustments to be replaced with additional adjustments on the subscription. + # (Only available for accounts that have migrated off of legacy subscription + # overrides) replace_adjustments: nil, + # Plan prices to be replaced with additional prices on the subscription. (Only + # available for accounts that have migrated off of legacy subscription overrides) replace_prices: nil, + # The duration of the trial period in days. If not provided, this defaults to the + # value specified in the plan. If `0` is provided, the trial on the plan will be + # skipped. trial_duration_days: nil, + # A list of customer IDs whose usage events will be aggregated and billed under + # this subscription. By default, a subscription only considers usage events + # associated with its attached customer's customer_id. When usage_customer_ids is + # provided, the subscription includes usage events from the specified customers + # only. Provided usage_customer_ids must be either the customer for this + # subscription itself, or any of that customer's children. usage_customer_ids: nil, request_options: {} ); end @@ -272,8 +328,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } REQUESTED_DATE = T.let(:requested_date, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption::TaggedSymbol) @@ -335,8 +390,19 @@ module Orb ) .returns(T.attached_class) end - def self.new(adjustment:, end_date: nil, plan_phase_order: nil, start_date: nil); end - + def self.new( + # The definition of a new adjustment to create and add to the subscription. + adjustment:, + # The end date of the adjustment interval. This is the date that the adjustment + # will stop affecting prices on the subscription. + end_date: nil, + # The phase to add this adjustment to. + plan_phase_order: nil, + # The start date of the adjustment interval. This is the date that the adjustment + # will start affecting prices on the subscription. If null, the adjustment will + # start when the phase or subscription starts. + start_date: nil + ); end sig do override .returns( @@ -389,13 +455,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, percentage_discount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -439,13 +506,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, usage_discount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -490,12 +558,13 @@ module Orb end def self.new( amount_discount:, + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -544,14 +613,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, + # The item ID that revenue from this minimum will be attributed to. item_id:, minimum_amount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -596,13 +667,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, maximum_amount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -772,15 +844,32 @@ module Orb .returns(T.attached_class) end def self.new( + # The definition of a new allocation price to create and add to the subscription. allocation_price: nil, + # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for this + # price. discounts: nil, + # The end date of the price interval. This is the date that the price will stop + # billing on the subscription. If null, billing will end when the phase or + # subscription ends. end_date: nil, + # The external price id of the price to add to the subscription. external_price_id: nil, + # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for + # this price. maximum_amount: nil, + # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for + # this price. minimum_amount: nil, + # The phase to add this price to. plan_phase_order: nil, + # The definition of a new price to create and add to the subscription. price: nil, + # The id of the price to add to the subscription. price_id: nil, + # The start date of the price interval. This is the date that the price will start + # billing on the subscription. If null, billing will start when the phase or + # subscription starts. start_date: nil ); end sig do @@ -859,8 +948,18 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:); end - + def self.new( + # An amount of the currency to allocate to the customer at the specified cadence. + amount:, + # The cadence at which to allocate the amount to the customer. + cadence:, + # An ISO 4217 currency string or a custom pricing unit identifier in which to bill + # this price. + currency:, + # Whether the allocated amount should expire at the end of the cadence or roll + # over to the next period. + expires_at_end_of_cadence: + ); end sig do override .returns( @@ -880,14 +979,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let( @@ -957,9 +1049,17 @@ module Orb ) .returns(T.attached_class) end - def self.new(discount_type:, amount_discount: nil, percentage_discount: nil, usage_discount: nil) - end - + def self.new( + discount_type:, + # Only available if discount_type is `amount`. + amount_discount: nil, + # Only available if discount_type is `percentage`. This is a number between 0 + # and 1. + percentage_discount: nil, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for + usage_discount: nil + ); end sig do override .returns( @@ -978,14 +1078,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Discount::DiscountType) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Discount::DiscountType::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } PERCENTAGE = T.let( @@ -1181,20 +1274,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :unit ); end @@ -1235,14 +1351,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -1292,8 +1401,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:); end - + def self.new( + # Rate per unit of usage + unit_amount: + ); end sig { override.returns({unit_amount: String}) } def to_hash; end end @@ -1320,8 +1431,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1341,14 +1456,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1395,8 +1503,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1416,14 +1528,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1613,20 +1718,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, package_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :package ); end @@ -1667,14 +1795,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -1729,8 +1850,13 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:); end - + def self.new( + # A currency amount to rate usage by + package_amount:, + # An integer amount to represent package size. For example, 1000 here would divide + # usage by 1000 before multiplying by package_amount in rating + package_size: + ); end sig { override.returns({package_amount: String, package_size: Integer}) } def to_hash; end end @@ -1757,8 +1883,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1778,14 +1908,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -1832,8 +1955,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -1853,14 +1980,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2050,20 +2170,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, matrix_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :matrix ); end @@ -2104,14 +2247,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -2187,8 +2323,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:); end - + def self.new( + # Default per unit rate for any usage not bucketed into a specified matrix_value + default_unit_amount:, + # One or two event property values to evaluate matrix groups by + dimensions:, + # Matrix values for specified matrix grouping keys + matrix_values: + ); end sig do override .returns( @@ -2220,8 +2362,14 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:); end - + def self.new( + # One or two matrix keys to filter usage to this Matrix value by. For example, + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. + dimension_values:, + # Unit price for the specified dimension_values + unit_amount: + ); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } def to_hash; end end @@ -2249,8 +2397,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2270,14 +2422,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2324,8 +2469,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2345,14 +2494,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2542,20 +2684,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered ); end @@ -2596,14 +2761,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -2669,8 +2827,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for rating based on total usage quantities into the specified tier + tiers: + ); end sig do override .returns( @@ -2703,8 +2863,14 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil); end - + def self.new( + # Exclusive tier starting value + first_unit:, + # Amount per unit + unit_amount:, + # Inclusive tier ending value. If null, this is treated as the last tier + last_unit: nil + ); end sig do override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) end @@ -2734,8 +2900,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2755,14 +2925,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -2809,8 +2972,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -2830,14 +2997,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3027,20 +3187,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_bps_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_bps ); end @@ -3081,14 +3264,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -3155,8 +3331,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # tiers + tiers: + ); end sig do override .returns( @@ -3195,8 +3374,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Per-event basis point rate + bps:, + # Exclusive tier starting value + minimum_amount:, + # Inclusive tier ending value + maximum_amount: nil, + # Per unit maximum to charge + per_unit_maximum: nil + ); end sig do override .returns( @@ -3234,8 +3421,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3255,14 +3446,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3309,8 +3493,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3330,14 +3518,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3528,19 +3709,42 @@ module Orb end def self.new( bps_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bps ); end @@ -3583,8 +3787,12 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil); end - + def self.new( + # Basis point take rate per event + bps:, + # Optional currency amount maximum to cap spend per event + per_unit_maximum: nil + ); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } def to_hash; end end @@ -3597,14 +3805,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -3670,8 +3871,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3691,14 +3896,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3745,8 +3943,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -3766,14 +3968,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -3964,19 +4159,42 @@ module Orb end def self.new( bulk_bps_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bulk_bps ); end @@ -4032,8 +4250,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a bulk BPS pricing model where all usage is aggregated to a single + # tier based on total volume + tiers: + ); end sig do override .returns( @@ -4063,8 +4284,14 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Basis points to rate on + bps:, + # Upper bound for tier + maximum_amount: nil, + # The maximum amount to charge for any one event + per_unit_maximum: nil + ); end sig do override.returns( { @@ -4086,14 +4313,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -4159,8 +4379,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4180,14 +4404,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4234,8 +4451,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4255,14 +4476,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4453,19 +4667,42 @@ module Orb end def self.new( bulk_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bulk ); end @@ -4520,8 +4757,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Bulk tiers for rating based on total usage volume + tiers: + ); end sig do override .returns( @@ -4544,8 +4783,12 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil); end - + def self.new( + # Amount per unit + unit_amount:, + # Upper bound for this tier + maximum_units: nil + ); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } def to_hash; end end @@ -4559,14 +4802,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -4632,8 +4868,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4653,14 +4893,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4707,8 +4940,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -4728,14 +4965,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -4907,20 +5137,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, threshold_total_amount_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :threshold_total_amount ); end @@ -4961,14 +5214,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -5034,8 +5280,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5055,14 +5305,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5109,8 +5352,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5130,14 +5377,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5309,20 +5549,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_package_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_package ); end @@ -5363,14 +5626,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -5436,8 +5692,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5457,14 +5717,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5511,8 +5764,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5532,14 +5789,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5711,20 +5961,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_with_minimum_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_with_minimum ); end @@ -5765,14 +6038,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -5838,8 +6104,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5859,14 +6129,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -5913,8 +6176,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -5934,14 +6201,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6113,20 +6373,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_with_percent_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :unit_with_percent ); end @@ -6167,14 +6450,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -6240,8 +6516,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6261,14 +6541,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6315,8 +6588,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6336,14 +6613,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6515,20 +6785,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, package_with_allocation_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :package_with_allocation ); end @@ -6569,14 +6862,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -6642,8 +6928,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6663,14 +6953,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6717,8 +7000,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -6738,14 +7025,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -6917,20 +7197,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_with_proration_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_with_proration ); end @@ -6971,14 +7274,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -7044,8 +7340,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7065,14 +7365,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7119,8 +7412,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7140,14 +7437,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7319,20 +7609,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_with_proration_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :unit_with_proration ); end @@ -7373,14 +7686,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -7446,8 +7752,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7467,14 +7777,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7521,8 +7824,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7542,14 +7849,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7721,20 +8021,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_allocation_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_allocation ); end @@ -7775,14 +8098,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -7848,8 +8164,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7869,14 +8189,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -7923,8 +8236,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -7944,14 +8261,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8123,20 +8433,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_with_prorated_minimum_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_with_prorated_minimum ); end @@ -8177,14 +8510,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -8250,8 +8576,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8271,14 +8601,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8325,8 +8648,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8346,14 +8673,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8526,19 +8846,42 @@ module Orb end def self.new( bulk_with_proration_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bulk_with_proration ); end @@ -8579,14 +8922,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -8652,8 +8988,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8673,14 +9013,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8727,8 +9060,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -8748,14 +9085,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -8927,20 +9257,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, scalable_matrix_with_unit_pricing_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :scalable_matrix_with_unit_pricing ); end @@ -8981,14 +9334,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -9054,8 +9400,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9075,14 +9425,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9129,8 +9472,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9150,14 +9497,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9329,20 +9669,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, scalable_matrix_with_tiered_pricing_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :scalable_matrix_with_tiered_pricing ); end @@ -9383,14 +9746,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -9456,8 +9812,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9477,14 +9837,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9531,8 +9884,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9552,14 +9909,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9731,20 +10081,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, cumulative_grouped_bulk_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :cumulative_grouped_bulk ); end @@ -9785,14 +10158,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -9858,8 +10224,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9879,14 +10249,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -9933,8 +10296,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -9954,14 +10321,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10133,20 +10493,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, max_group_tiered_package_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :max_group_tiered_package ); end @@ -10187,14 +10570,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -10260,8 +10636,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10281,14 +10661,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10335,8 +10708,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10356,14 +10733,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10535,20 +10905,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_with_metered_minimum_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_with_metered_minimum ); end @@ -10589,14 +10982,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -10662,8 +11048,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10683,14 +11073,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10737,8 +11120,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -10758,14 +11145,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -10937,20 +11317,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, matrix_with_display_name_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :matrix_with_display_name ); end @@ -10991,14 +11394,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -11064,8 +11460,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -11085,14 +11485,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11139,8 +11532,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -11160,14 +11557,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11339,20 +11729,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_tiered_package_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_tiered_package ); end @@ -11393,14 +11806,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -11466,8 +11872,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -11487,14 +11897,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11541,8 +11944,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -11562,14 +11969,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -11613,14 +12013,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } UNCHANGED = T.let(:unchanged, Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment::TaggedSymbol) @@ -11664,8 +12057,20 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -11676,8 +12081,10 @@ module Orb attr_accessor :adjustment_id sig { params(adjustment_id: String).returns(T.attached_class) } - def self.new(adjustment_id:); end - + def self.new( + # The id of the adjustment to remove on the subscription. + adjustment_id: + ); end sig { override.returns({adjustment_id: String}) } def to_hash; end end @@ -11694,8 +12101,12 @@ module Orb sig do params(external_price_id: T.nilable(String), price_id: T.nilable(String)).returns(T.attached_class) end - def self.new(external_price_id: nil, price_id: nil); end - + def self.new( + # The external price id of the price to remove on the subscription. + external_price_id: nil, + # The id of the price to remove on the subscription. + price_id: nil + ); end sig { override.returns({external_price_id: T.nilable(String), price_id: T.nilable(String)}) } def to_hash; end end @@ -11733,8 +12144,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(adjustment:, replaces_adjustment_id:); end - + def self.new( + # The definition of a new adjustment to create and add to the subscription. + adjustment:, + # The id of the adjustment on the plan to replace in the subscription. + replaces_adjustment_id: + ); end sig do override .returns( @@ -11785,13 +12200,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, percentage_discount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -11835,13 +12251,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, usage_discount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -11886,12 +12303,13 @@ module Orb end def self.new( amount_discount:, + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -11940,14 +12358,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, + # The item ID that revenue from this minimum will be attributed to. item_id:, minimum_amount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -11992,13 +12412,14 @@ module Orb .returns(T.attached_class) end def self.new( + # The set of price IDs to which this adjustment applies. applies_to_price_ids:, maximum_amount:, + # When false, this adjustment will be applied to a single price. Otherwise, it + # will be applied at the invoice level, possibly to multiple prices. is_invoice_level: nil, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -12159,14 +12580,26 @@ module Orb .returns(T.attached_class) end def self.new( + # The id of the price on the plan to replace in the subscription. replaces_price_id:, + # The definition of a new allocation price to create and add to the subscription. allocation_price: nil, + # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for the + # replacement price. discounts: nil, + # The external price id of the price to add to the subscription. external_price_id: nil, + # The new quantity of the price, if the price is a fixed price. fixed_price_quantity: nil, + # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for + # the replacement price. maximum_amount: nil, + # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for + # the replacement price. minimum_amount: nil, + # The definition of a new price to create and add to the subscription. price: nil, + # The id of the price to add to the subscription. price_id: nil ); end sig do @@ -12248,8 +12681,18 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:); end - + def self.new( + # An amount of the currency to allocate to the customer at the specified cadence. + amount:, + # The cadence at which to allocate the amount to the customer. + cadence:, + # An ISO 4217 currency string or a custom pricing unit identifier in which to bill + # this price. + currency:, + # Whether the allocated amount should expire at the end of the cadence or roll + # over to the next period. + expires_at_end_of_cadence: + ); end sig do override .returns( @@ -12269,14 +12712,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::Cadence) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ONE_TIME = T.let( @@ -12346,9 +12782,17 @@ module Orb ) .returns(T.attached_class) end - def self.new(discount_type:, amount_discount: nil, percentage_discount: nil, usage_discount: nil) - end - + def self.new( + discount_type:, + # Only available if discount_type is `amount`. + amount_discount: nil, + # Only available if discount_type is `percentage`. This is a number between 0 + # and 1. + percentage_discount: nil, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for + usage_discount: nil + ); end sig do override .returns( @@ -12367,14 +12811,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Discount::DiscountType) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Discount::DiscountType::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } PERCENTAGE = T.let( @@ -12570,20 +13007,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :unit ); end @@ -12624,14 +13084,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -12681,8 +13134,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:); end - + def self.new( + # Rate per unit of usage + unit_amount: + ); end sig { override.returns({unit_amount: String}) } def to_hash; end end @@ -12709,8 +13164,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -12730,14 +13189,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -12784,8 +13236,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -12805,14 +13261,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -13002,20 +13451,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, package_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :package ); end @@ -13056,14 +13528,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -13118,8 +13583,13 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:); end - + def self.new( + # A currency amount to rate usage by + package_amount:, + # An integer amount to represent package size. For example, 1000 here would divide + # usage by 1000 before multiplying by package_amount in rating + package_size: + ); end sig { override.returns({package_amount: String, package_size: Integer}) } def to_hash; end end @@ -13146,8 +13616,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -13167,14 +13641,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -13221,8 +13688,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -13242,14 +13713,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -13439,20 +13903,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, matrix_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :matrix ); end @@ -13493,14 +13980,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -13576,8 +14056,14 @@ module Orb ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:); end - + def self.new( + # Default per unit rate for any usage not bucketed into a specified matrix_value + default_unit_amount:, + # One or two event property values to evaluate matrix groups by + dimensions:, + # Matrix values for specified matrix grouping keys + matrix_values: + ); end sig do override .returns( @@ -13609,8 +14095,14 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:); end - + def self.new( + # One or two matrix keys to filter usage to this Matrix value by. For example, + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. + dimension_values:, + # Unit price for the specified dimension_values + unit_amount: + ); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } def to_hash; end end @@ -13638,8 +14130,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -13659,14 +14155,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -13713,8 +14202,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -13734,14 +14227,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -13931,20 +14417,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered ); end @@ -13985,14 +14494,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -14058,8 +14560,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for rating based on total usage quantities into the specified tier + tiers: + ); end sig do override .returns( @@ -14092,8 +14596,14 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil); end - + def self.new( + # Exclusive tier starting value + first_unit:, + # Amount per unit + unit_amount:, + # Inclusive tier ending value. If null, this is treated as the last tier + last_unit: nil + ); end sig do override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) end @@ -14123,8 +14633,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -14144,14 +14658,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -14198,8 +14705,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -14219,14 +14730,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -14416,20 +14920,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_bps_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_bps ); end @@ -14470,14 +14997,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -14544,8 +15064,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified + # tiers + tiers: + ); end sig do override .returns( @@ -14584,8 +15107,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Per-event basis point rate + bps:, + # Exclusive tier starting value + minimum_amount:, + # Inclusive tier ending value + maximum_amount: nil, + # Per unit maximum to charge + per_unit_maximum: nil + ); end sig do override .returns( @@ -14623,8 +15154,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -14644,14 +15179,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -14698,8 +15226,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -14719,14 +15251,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -14917,19 +15442,42 @@ module Orb end def self.new( bps_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bps ); end @@ -14972,8 +15520,12 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil); end - + def self.new( + # Basis point take rate per event + bps:, + # Optional currency amount maximum to cap spend per event + per_unit_maximum: nil + ); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } def to_hash; end end @@ -14986,14 +15538,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -15059,8 +15604,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -15080,14 +15629,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -15134,8 +15676,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -15155,14 +15701,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -15353,19 +15892,42 @@ module Orb end def self.new( bulk_bps_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bulk_bps ); end @@ -15421,8 +15983,11 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Tiers for a bulk BPS pricing model where all usage is aggregated to a single + # tier based on total volume + tiers: + ); end sig do override .returns( @@ -15452,8 +16017,14 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end - + def self.new( + # Basis points to rate on + bps:, + # Upper bound for tier + maximum_amount: nil, + # The maximum amount to charge for any one event + per_unit_maximum: nil + ); end sig do override.returns( { @@ -15475,14 +16046,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -15548,8 +16112,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -15569,14 +16137,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -15623,8 +16184,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -15644,14 +16209,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -15842,19 +16400,42 @@ module Orb end def self.new( bulk_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bulk ); end @@ -15909,8 +16490,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:); end - + def self.new( + # Bulk tiers for rating based on total usage volume + tiers: + ); end sig do override .returns( @@ -15933,8 +16516,12 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil); end - + def self.new( + # Amount per unit + unit_amount:, + # Upper bound for this tier + maximum_units: nil + ); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } def to_hash; end end @@ -15948,14 +16535,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -16021,8 +16601,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -16042,14 +16626,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -16096,8 +16673,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -16117,14 +16698,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -16296,20 +16870,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, threshold_total_amount_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :threshold_total_amount ); end @@ -16350,14 +16947,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -16423,8 +17013,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -16444,14 +17038,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -16498,8 +17085,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -16519,14 +17110,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -16698,20 +17282,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_package_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_package ); end @@ -16752,14 +17359,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -16825,8 +17425,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -16846,14 +17450,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -16900,8 +17497,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -16921,14 +17522,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -17100,20 +17694,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_with_minimum_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_with_minimum ); end @@ -17154,14 +17771,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -17227,8 +17837,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -17248,14 +17862,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -17302,8 +17909,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -17323,14 +17934,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -17502,20 +18106,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_with_percent_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :unit_with_percent ); end @@ -17556,14 +18183,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -17629,8 +18249,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -17650,14 +18274,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -17704,8 +18321,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -17725,14 +18346,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -17904,20 +18518,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, package_with_allocation_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :package_with_allocation ); end @@ -17958,14 +18595,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -18031,8 +18661,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -18052,14 +18686,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -18106,8 +18733,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -18127,14 +18758,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -18306,20 +18930,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, tiered_with_proration_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :tiered_with_proration ); end @@ -18360,14 +19007,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -18433,8 +19073,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -18454,14 +19098,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -18508,8 +19145,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -18529,14 +19170,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -18708,20 +19342,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, unit_with_proration_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :unit_with_proration ); end @@ -18762,14 +19419,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -18835,8 +19485,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -18856,14 +19510,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -18910,8 +19557,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -18931,14 +19582,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -19110,20 +19754,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_allocation_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_allocation ); end @@ -19164,14 +19831,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -19237,8 +19897,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -19258,14 +19922,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -19312,8 +19969,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -19333,14 +19994,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -19512,20 +20166,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_with_prorated_minimum_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_with_prorated_minimum ); end @@ -19566,14 +20243,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -19639,8 +20309,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -19660,14 +20334,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -19714,8 +20381,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -19735,14 +20406,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -19915,19 +20579,42 @@ module Orb end def self.new( bulk_with_proration_config:, + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :bulk_with_proration ); end @@ -19968,14 +20655,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -20041,8 +20721,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -20062,14 +20746,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -20116,8 +20793,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -20137,14 +20818,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -20316,20 +20990,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, scalable_matrix_with_unit_pricing_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :scalable_matrix_with_unit_pricing ); end @@ -20370,14 +21067,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -20443,8 +21133,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -20464,14 +21158,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -20518,8 +21205,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -20539,14 +21230,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -20718,20 +21402,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, scalable_matrix_with_tiered_pricing_config:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :scalable_matrix_with_tiered_pricing ); end @@ -20772,14 +21479,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -20845,8 +21545,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -20866,14 +21570,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -20920,8 +21617,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -20941,14 +21642,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -21120,20 +21814,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, cumulative_grouped_bulk_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :cumulative_grouped_bulk ); end @@ -21174,14 +21891,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -21247,8 +21957,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -21268,14 +21982,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -21322,8 +22029,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -21343,14 +22054,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -21522,20 +22226,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, max_group_tiered_package_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :max_group_tiered_package ); end @@ -21576,14 +22303,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -21649,8 +22369,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -21670,14 +22394,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -21724,8 +22441,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -21745,14 +22466,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -21924,20 +22638,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_with_metered_minimum_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_with_metered_minimum ); end @@ -21978,14 +22715,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -22051,8 +22781,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -22072,14 +22806,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -22126,8 +22853,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -22147,14 +22878,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -22326,20 +23050,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, + # The id of the item the price will be associated with. item_id:, matrix_with_display_name_config:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :matrix_with_display_name ); end @@ -22380,14 +23127,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -22453,8 +23193,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -22474,14 +23218,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -22528,8 +23265,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -22549,14 +23290,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -22728,20 +23462,43 @@ module Orb .returns(T.attached_class) end def self.new( + # The cadence to bill for this price on. cadence:, grouped_tiered_package_config:, + # The id of the item the price will be associated with. item_id:, + # The name of the price. name:, + # The id of the billable metric for the price. Only needed if the price is + # usage-based. billable_metric_id: nil, + # If the Price represents a fixed cost, the price will be billed in-advance if + # this is true, and in-arrears if this is false. billed_in_advance: nil, + # For custom cadence: specifies the duration of the billing period in days or + # months. billing_cycle_configuration: nil, + # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, + # An ISO 4217 currency string, or custom pricing unit identifier, in which this + # price is billed. currency: nil, + # An alias for the price. external_price_id: nil, + # If the Price represents a fixed cost, this represents the quantity of units + # applied. fixed_price_quantity: nil, + # The property used to group this price on an invoice invoice_grouping_key: nil, + # Within each billing cycle, specifies the cadence at which invoices are produced. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # A transient ID that can be used to reference this price when adding adjustments + # in the same API call. reference_id: nil, model_type: :grouped_tiered_package ); end @@ -22782,14 +23539,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUAL = T.let( @@ -22855,8 +23605,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -22876,14 +23630,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( @@ -22930,8 +23677,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:); end - + def self.new( + # The duration of the billing period. + duration:, + # The unit of billing period duration. + duration_unit: + ); end sig do override .returns( @@ -22951,14 +23702,7 @@ module Orb T.type_alias do T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } DAY = T.let( diff --git a/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi b/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi index c4947a04..fa9b5bf2 100644 --- a/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +++ b/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi @@ -269,31 +269,90 @@ module Orb end def self.new( id:, + # The current plan phase that is active, only if the subscription's plan has + # phases. active_plan_phase_order:, + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. adjustment_intervals:, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. auto_collection:, billing_cycle_anchor_configuration:, + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. billing_cycle_day:, created_at:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. current_billing_period_start_date:, + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. customer:, + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo:, + # The discount intervals for this subscription sorted by the start_date. discount_intervals:, + # The date Orb stops billing for this subscription. end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, + # The maximum intervals for this subscription sorted by the start_date. maximum_intervals:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The minimum intervals for this subscription sorted by the start_date. minimum_intervals:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms:, + # A pending subscription change if one exists on this subscription. pending_subscription_change:, + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). plan:, + # The price intervals for this subscription. price_intervals:, redeemed_coupon:, + # The date Orb starts billing for this subscription. start_date:, status:, trial_info:, + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. changed_resources: nil ); end sig do @@ -384,8 +443,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end - + def self.new( + id:, + adjustment:, + # The price interval IDs that this adjustment applies to. + applies_to_price_interval_ids:, + # The end date of the adjustment interval. + end_date:, + # The start date of the adjustment interval. + start_date: + ); end sig do override .returns( @@ -452,10 +519,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -519,10 +593,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -586,10 +667,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -658,11 +746,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -727,10 +823,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -783,8 +886,20 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -828,10 +943,15 @@ module Orb .returns(T.attached_class) end def self.new( + # Only available if discount_type is `amount`. amount_discount:, + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, discount_type: :amount ); end @@ -888,10 +1008,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. percentage_discount:, + # The start date of the discount interval. start_date:, discount_type: :percentage ); end @@ -948,10 +1074,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for usage_discount:, discount_type: :usage ); end @@ -1038,14 +1170,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this maximum interval applies to. applies_to_price_ids:, + # The price interval ids that this maximum interval applies to. applies_to_price_interval_ids:, + # The end date of the maximum interval. end_date:, + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. maximum_amount:, + # The start date of the maximum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1094,14 +1230,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this minimum interval applies to. applies_to_price_ids:, + # The price interval ids that this minimum interval applies to. applies_to_price_interval_ids:, + # The end date of the minimum interval. end_date:, + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. minimum_amount:, + # The start date of the minimum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1282,14 +1422,40 @@ module Orb end def self.new( id:, + # The day of the month that Orb bills for this price billing_cycle_day:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. current_billing_period_start_date:, + # The end date of the price interval. This is the date that Orb stops billing for + # this price. end_date:, + # An additional filter to apply to usage queries. filter:, + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. fixed_fee_quantity_transitions:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # The start date of the price interval. This is the date that Orb starts billing + # for this price. start_date:, + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. usage_customer_ids: ); end sig do @@ -1384,8 +1550,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol) @@ -1435,8 +1600,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end - + def self.new( + # The credit notes that were created as part of this operation. + created_credit_notes:, + # The invoices that were created as part of this operation. + created_invoices:, + # The credit notes that were voided as part of this operation. + voided_credit_notes:, + # The invoices that were voided as part of this operation. + voided_invoices: + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_trigger_phase_params.rbi b/rbi/lib/orb/models/subscription_trigger_phase_params.rbi index f401a7e5..3982c88c 100644 --- a/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +++ b/rbi/lib/orb/models/subscription_trigger_phase_params.rbi @@ -25,8 +25,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(allow_invoice_credit_or_void: nil, effective_date: nil, request_options: {}); end - + def self.new( + # If false, this request will fail if it would void an issued invoice or create a + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. + allow_invoice_credit_or_void: nil, + # The date on which the phase change should take effect. If not provided, defaults + # to today in the customer's timezone. + effective_date: nil, + request_options: {} + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_trigger_phase_response.rbi b/rbi/lib/orb/models/subscription_trigger_phase_response.rbi index 83e42ed1..fdb6feb3 100644 --- a/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +++ b/rbi/lib/orb/models/subscription_trigger_phase_response.rbi @@ -250,31 +250,90 @@ module Orb end def self.new( id:, + # The current plan phase that is active, only if the subscription's plan has + # phases. active_plan_phase_order:, + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. adjustment_intervals:, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. auto_collection:, billing_cycle_anchor_configuration:, + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. billing_cycle_day:, created_at:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. current_billing_period_start_date:, + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. customer:, + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo:, + # The discount intervals for this subscription sorted by the start_date. discount_intervals:, + # The date Orb stops billing for this subscription. end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, + # The maximum intervals for this subscription sorted by the start_date. maximum_intervals:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The minimum intervals for this subscription sorted by the start_date. minimum_intervals:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms:, + # A pending subscription change if one exists on this subscription. pending_subscription_change:, + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). plan:, + # The price intervals for this subscription. price_intervals:, redeemed_coupon:, + # The date Orb starts billing for this subscription. start_date:, status:, trial_info:, + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. changed_resources: nil ); end sig do @@ -365,8 +424,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end - + def self.new( + id:, + adjustment:, + # The price interval IDs that this adjustment applies to. + applies_to_price_interval_ids:, + # The end date of the adjustment interval. + end_date:, + # The start date of the adjustment interval. + start_date: + ); end sig do override .returns( @@ -433,10 +500,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -500,10 +574,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -567,10 +648,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -639,11 +727,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -708,10 +804,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -764,8 +867,20 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -809,10 +924,15 @@ module Orb .returns(T.attached_class) end def self.new( + # Only available if discount_type is `amount`. amount_discount:, + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, discount_type: :amount ); end @@ -869,10 +989,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. percentage_discount:, + # The start date of the discount interval. start_date:, discount_type: :percentage ); end @@ -929,10 +1055,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for usage_discount:, discount_type: :usage ); end @@ -1019,14 +1151,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this maximum interval applies to. applies_to_price_ids:, + # The price interval ids that this maximum interval applies to. applies_to_price_interval_ids:, + # The end date of the maximum interval. end_date:, + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. maximum_amount:, + # The start date of the maximum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1075,14 +1211,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this minimum interval applies to. applies_to_price_ids:, + # The price interval ids that this minimum interval applies to. applies_to_price_interval_ids:, + # The end date of the minimum interval. end_date:, + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. minimum_amount:, + # The start date of the minimum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1263,14 +1403,40 @@ module Orb end def self.new( id:, + # The day of the month that Orb bills for this price billing_cycle_day:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. current_billing_period_start_date:, + # The end date of the price interval. This is the date that Orb stops billing for + # this price. end_date:, + # An additional filter to apply to usage queries. filter:, + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. fixed_fee_quantity_transitions:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # The start date of the price interval. This is the date that Orb starts billing + # for this price. start_date:, + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. usage_customer_ids: ); end sig do @@ -1364,8 +1530,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol) @@ -1415,8 +1580,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end - + def self.new( + # The credit notes that were created as part of this operation. + created_credit_notes:, + # The invoices that were created as part of this operation. + created_invoices:, + # The credit notes that were voided as part of this operation. + voided_credit_notes:, + # The invoices that were voided as part of this operation. + voided_invoices: + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi b/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi index 7fac191d..e693a9e6 100644 --- a/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi @@ -269,31 +269,90 @@ module Orb end def self.new( id:, + # The current plan phase that is active, only if the subscription's plan has + # phases. active_plan_phase_order:, + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. adjustment_intervals:, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. auto_collection:, billing_cycle_anchor_configuration:, + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. billing_cycle_day:, created_at:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. current_billing_period_start_date:, + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. customer:, + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo:, + # The discount intervals for this subscription sorted by the start_date. discount_intervals:, + # The date Orb stops billing for this subscription. end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, + # The maximum intervals for this subscription sorted by the start_date. maximum_intervals:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The minimum intervals for this subscription sorted by the start_date. minimum_intervals:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms:, + # A pending subscription change if one exists on this subscription. pending_subscription_change:, + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). plan:, + # The price intervals for this subscription. price_intervals:, redeemed_coupon:, + # The date Orb starts billing for this subscription. start_date:, status:, trial_info:, + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. changed_resources: nil ); end sig do @@ -384,8 +443,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end - + def self.new( + id:, + adjustment:, + # The price interval IDs that this adjustment applies to. + applies_to_price_interval_ids:, + # The end date of the adjustment interval. + end_date:, + # The start date of the adjustment interval. + start_date: + ); end sig do override .returns( @@ -452,10 +519,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -519,10 +593,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -586,10 +667,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -658,11 +746,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -727,10 +823,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -783,8 +886,20 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -828,10 +943,15 @@ module Orb .returns(T.attached_class) end def self.new( + # Only available if discount_type is `amount`. amount_discount:, + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, discount_type: :amount ); end @@ -888,10 +1008,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. percentage_discount:, + # The start date of the discount interval. start_date:, discount_type: :percentage ); end @@ -948,10 +1074,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for usage_discount:, discount_type: :usage ); end @@ -1038,14 +1170,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this maximum interval applies to. applies_to_price_ids:, + # The price interval ids that this maximum interval applies to. applies_to_price_interval_ids:, + # The end date of the maximum interval. end_date:, + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. maximum_amount:, + # The start date of the maximum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1094,14 +1230,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this minimum interval applies to. applies_to_price_ids:, + # The price interval ids that this minimum interval applies to. applies_to_price_interval_ids:, + # The end date of the minimum interval. end_date:, + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. minimum_amount:, + # The start date of the minimum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1282,14 +1422,40 @@ module Orb end def self.new( id:, + # The day of the month that Orb bills for this price billing_cycle_day:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. current_billing_period_start_date:, + # The end date of the price interval. This is the date that Orb stops billing for + # this price. end_date:, + # An additional filter to apply to usage queries. filter:, + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. fixed_fee_quantity_transitions:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # The start date of the price interval. This is the date that Orb starts billing + # for this price. start_date:, + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. usage_customer_ids: ); end sig do @@ -1384,8 +1550,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status::TaggedSymbol) @@ -1436,8 +1601,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end - + def self.new( + # The credit notes that were created as part of this operation. + created_credit_notes:, + # The invoices that were created as part of this operation. + created_invoices:, + # The credit notes that were voided as part of this operation. + voided_credit_notes:, + # The invoices that were voided as part of this operation. + voided_invoices: + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi b/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi index 782a87db..acf74383 100644 --- a/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi @@ -14,8 +14,11 @@ module Orb params(price_id: String, request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)) .returns(T.attached_class) end - def self.new(price_id:, request_options: {}); end - + def self.new( + # Price for which the updates should be cleared. Must be a fixed fee. + price_id:, + request_options: {} + ); end sig { override.returns({price_id: String, request_options: Orb::RequestOptions}) } def to_hash; end end diff --git a/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi b/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi index e081093f..1b080d05 100644 --- a/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi @@ -319,31 +319,90 @@ module Orb end def self.new( id:, + # The current plan phase that is active, only if the subscription's plan has + # phases. active_plan_phase_order:, + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. adjustment_intervals:, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. auto_collection:, billing_cycle_anchor_configuration:, + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. billing_cycle_day:, created_at:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. current_billing_period_start_date:, + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. customer:, + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo:, + # The discount intervals for this subscription sorted by the start_date. discount_intervals:, + # The date Orb stops billing for this subscription. end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, + # The maximum intervals for this subscription sorted by the start_date. maximum_intervals:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The minimum intervals for this subscription sorted by the start_date. minimum_intervals:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms:, + # A pending subscription change if one exists on this subscription. pending_subscription_change:, + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). plan:, + # The price intervals for this subscription. price_intervals:, redeemed_coupon:, + # The date Orb starts billing for this subscription. start_date:, status:, trial_info:, + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. changed_resources: nil ); end sig do @@ -434,8 +493,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end - + def self.new( + id:, + adjustment:, + # The price interval IDs that this adjustment applies to. + applies_to_price_interval_ids:, + # The end date of the adjustment interval. + end_date:, + # The start date of the adjustment interval. + start_date: + ); end sig do override .returns( @@ -502,10 +569,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -569,10 +643,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -636,10 +717,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -708,11 +796,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -777,10 +873,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -833,8 +936,20 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -878,10 +993,15 @@ module Orb .returns(T.attached_class) end def self.new( + # Only available if discount_type is `amount`. amount_discount:, + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, discount_type: :amount ); end @@ -938,10 +1058,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. percentage_discount:, + # The start date of the discount interval. start_date:, discount_type: :percentage ); end @@ -998,10 +1124,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for usage_discount:, discount_type: :usage ); end @@ -1088,14 +1220,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this maximum interval applies to. applies_to_price_ids:, + # The price interval ids that this maximum interval applies to. applies_to_price_interval_ids:, + # The end date of the maximum interval. end_date:, + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. maximum_amount:, + # The start date of the maximum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1144,14 +1280,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this minimum interval applies to. applies_to_price_ids:, + # The price interval ids that this minimum interval applies to. applies_to_price_interval_ids:, + # The end date of the minimum interval. end_date:, + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. minimum_amount:, + # The start date of the minimum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1334,14 +1474,40 @@ module Orb end def self.new( id:, + # The day of the month that Orb bills for this price billing_cycle_day:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. current_billing_period_start_date:, + # The end date of the price interval. This is the date that Orb stops billing for + # this price. end_date:, + # An additional filter to apply to usage queries. filter:, + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. fixed_fee_quantity_transitions:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # The start date of the price interval. This is the date that Orb starts billing + # for this price. start_date:, + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. usage_customer_ids: ); end sig do @@ -1438,14 +1604,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status::TaggedSymbol) @@ -1503,8 +1662,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end - + def self.new( + # The credit notes that were created as part of this operation. + created_credit_notes:, + # The invoices that were created as part of this operation. + created_invoices:, + # The credit notes that were voided as part of this operation. + voided_credit_notes:, + # The invoices that were voided as part of this operation. + voided_invoices: + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi b/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi index 4024ef64..dc3e8c36 100644 --- a/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi @@ -305,31 +305,90 @@ module Orb end def self.new( id:, + # The current plan phase that is active, only if the subscription's plan has + # phases. active_plan_phase_order:, + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. adjustment_intervals:, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. auto_collection:, billing_cycle_anchor_configuration:, + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. billing_cycle_day:, created_at:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. current_billing_period_start_date:, + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. customer:, + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo:, + # The discount intervals for this subscription sorted by the start_date. discount_intervals:, + # The date Orb stops billing for this subscription. end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, + # The maximum intervals for this subscription sorted by the start_date. maximum_intervals:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The minimum intervals for this subscription sorted by the start_date. minimum_intervals:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms:, + # A pending subscription change if one exists on this subscription. pending_subscription_change:, + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). plan:, + # The price intervals for this subscription. price_intervals:, redeemed_coupon:, + # The date Orb starts billing for this subscription. start_date:, status:, trial_info:, + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. changed_resources: nil ); end sig do @@ -420,8 +479,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end - + def self.new( + id:, + adjustment:, + # The price interval IDs that this adjustment applies to. + applies_to_price_interval_ids:, + # The end date of the adjustment interval. + end_date:, + # The start date of the adjustment interval. + start_date: + ); end sig do override .returns( @@ -488,10 +555,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -555,10 +629,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -622,10 +703,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -694,11 +782,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -763,10 +859,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -819,8 +922,20 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -864,10 +979,15 @@ module Orb .returns(T.attached_class) end def self.new( + # Only available if discount_type is `amount`. amount_discount:, + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, discount_type: :amount ); end @@ -924,10 +1044,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. percentage_discount:, + # The start date of the discount interval. start_date:, discount_type: :percentage ); end @@ -984,10 +1110,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for usage_discount:, discount_type: :usage ); end @@ -1074,14 +1206,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this maximum interval applies to. applies_to_price_ids:, + # The price interval ids that this maximum interval applies to. applies_to_price_interval_ids:, + # The end date of the maximum interval. end_date:, + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. maximum_amount:, + # The start date of the maximum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1130,14 +1266,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this minimum interval applies to. applies_to_price_ids:, + # The price interval ids that this minimum interval applies to. applies_to_price_interval_ids:, + # The end date of the minimum interval. end_date:, + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. minimum_amount:, + # The start date of the minimum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1318,14 +1458,40 @@ module Orb end def self.new( id:, + # The day of the month that Orb bills for this price billing_cycle_day:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. current_billing_period_start_date:, + # The end date of the price interval. This is the date that Orb stops billing for + # this price. end_date:, + # An additional filter to apply to usage queries. filter:, + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. fixed_fee_quantity_transitions:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # The start date of the price interval. This is the date that Orb starts billing + # for this price. start_date:, + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. usage_customer_ids: ); end sig do @@ -1420,8 +1586,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status::TaggedSymbol) @@ -1477,8 +1642,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end - + def self.new( + # The credit notes that were created as part of this operation. + created_credit_notes:, + # The invoices that were created as part of this operation. + created_invoices:, + # The credit notes that were voided as part of this operation. + voided_credit_notes:, + # The invoices that were voided as part of this operation. + voided_invoices: + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi index 227d3805..277eee83 100644 --- a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +++ b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi @@ -46,10 +46,20 @@ module Orb .returns(T.attached_class) end def self.new( + # Price for which the quantity should be updated. Must be a fixed fee. price_id:, quantity:, + # If false, this request will fail if it would void an issued invoice or create a + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. allow_invoice_credit_or_void: nil, + # Determines when the change takes effect. Note that if `effective_date` is + # specified, this defaults to `effective_date`. Otherwise, this defaults to + # `immediate` unless it's explicitly set to `upcoming_invoice`. change_option: nil, + # The date that the quantity change should take effect, localized to the + # customer's timezone. Ifthis parameter is not passed in, the quantity change is + # effective according to `change_option`. effective_date: nil, request_options: {} ); end @@ -76,8 +86,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } IMMEDIATE = T.let(:immediate, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi index 950a33ca..c77ff2e6 100644 --- a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +++ b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi @@ -269,31 +269,90 @@ module Orb end def self.new( id:, + # The current plan phase that is active, only if the subscription's plan has + # phases. active_plan_phase_order:, + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. adjustment_intervals:, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. auto_collection:, billing_cycle_anchor_configuration:, + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. billing_cycle_day:, created_at:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. current_billing_period_start_date:, + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. customer:, + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo:, + # The discount intervals for this subscription sorted by the start_date. discount_intervals:, + # The date Orb stops billing for this subscription. end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, + # The maximum intervals for this subscription sorted by the start_date. maximum_intervals:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The minimum intervals for this subscription sorted by the start_date. minimum_intervals:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms:, + # A pending subscription change if one exists on this subscription. pending_subscription_change:, + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). plan:, + # The price intervals for this subscription. price_intervals:, redeemed_coupon:, + # The date Orb starts billing for this subscription. start_date:, status:, trial_info:, + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. changed_resources: nil ); end sig do @@ -384,8 +443,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end - + def self.new( + id:, + adjustment:, + # The price interval IDs that this adjustment applies to. + applies_to_price_interval_ids:, + # The end date of the adjustment interval. + end_date:, + # The start date of the adjustment interval. + start_date: + ); end sig do override .returns( @@ -452,10 +519,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -519,10 +593,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -586,10 +667,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -658,11 +746,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -727,10 +823,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -783,8 +886,20 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -828,10 +943,15 @@ module Orb .returns(T.attached_class) end def self.new( + # Only available if discount_type is `amount`. amount_discount:, + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, discount_type: :amount ); end @@ -888,10 +1008,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. percentage_discount:, + # The start date of the discount interval. start_date:, discount_type: :percentage ); end @@ -948,10 +1074,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for usage_discount:, discount_type: :usage ); end @@ -1038,14 +1170,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this maximum interval applies to. applies_to_price_ids:, + # The price interval ids that this maximum interval applies to. applies_to_price_interval_ids:, + # The end date of the maximum interval. end_date:, + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. maximum_amount:, + # The start date of the maximum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1094,14 +1230,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this minimum interval applies to. applies_to_price_ids:, + # The price interval ids that this minimum interval applies to. applies_to_price_interval_ids:, + # The end date of the minimum interval. end_date:, + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. minimum_amount:, + # The start date of the minimum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1282,14 +1422,40 @@ module Orb end def self.new( id:, + # The day of the month that Orb bills for this price billing_cycle_day:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. current_billing_period_start_date:, + # The end date of the price interval. This is the date that Orb stops billing for + # this price. end_date:, + # An additional filter to apply to usage queries. filter:, + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. fixed_fee_quantity_transitions:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # The start date of the price interval. This is the date that Orb starts billing + # for this price. start_date:, + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. usage_customer_ids: ); end sig do @@ -1384,8 +1550,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol) @@ -1436,8 +1601,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end - + def self.new( + # The credit notes that were created as part of this operation. + created_credit_notes:, + # The invoices that were created as part of this operation. + created_invoices:, + # The credit notes that were voided as part of this operation. + voided_credit_notes:, + # The invoices that were voided as part of this operation. + voided_invoices: + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_update_params.rbi b/rbi/lib/orb/models/subscription_update_params.rbi index e8ca952d..c4f7c098 100644 --- a/rbi/lib/orb/models/subscription_update_params.rbi +++ b/rbi/lib/orb/models/subscription_update_params.rbi @@ -48,10 +48,25 @@ module Orb .returns(T.attached_class) end def self.new( + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. auto_collection: nil, + # Determines the default memo on this subscription's invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo: nil, + # When this subscription's accrued usage reaches this threshold, an invoice will + # be issued for the subscription. If not specified, invoices will only be issued + # at the end of the billing period. invoicing_threshold: nil, + # User-specified key/value pairs for the resource. Individual keys can be removed + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms: nil, request_options: {} ); end diff --git a/rbi/lib/orb/models/subscription_update_trial_params.rbi b/rbi/lib/orb/models/subscription_update_trial_params.rbi index a0cd4d80..a897d806 100644 --- a/rbi/lib/orb/models/subscription_update_trial_params.rbi +++ b/rbi/lib/orb/models/subscription_update_trial_params.rbi @@ -27,8 +27,15 @@ module Orb ) .returns(T.attached_class) end - def self.new(trial_end_date:, shift: nil, request_options: {}); end - + def self.new( + # The new date that the trial should end, or the literal string `immediate` to end + # the trial immediately. + trial_end_date:, + # If true, shifts subsequent price and adjustment intervals (preserving their + # durations, but adjusting their absolute dates). + shift: nil, + request_options: {} + ); end sig do override .returns( @@ -46,12 +53,11 @@ module Orb module TrialEndDate extend Orb::Internal::Type::Union - sig { override.returns([Time, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate::OrSymbol]) } + sig { override.returns([Time, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate::TaggedSymbol]) } def self.variants; end TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } IMMEDIATE = T.let(:immediate, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate::TaggedSymbol) end diff --git a/rbi/lib/orb/models/subscription_update_trial_response.rbi b/rbi/lib/orb/models/subscription_update_trial_response.rbi index 021652a7..8b6989fd 100644 --- a/rbi/lib/orb/models/subscription_update_trial_response.rbi +++ b/rbi/lib/orb/models/subscription_update_trial_response.rbi @@ -248,31 +248,90 @@ module Orb end def self.new( id:, + # The current plan phase that is active, only if the subscription's plan has + # phases. active_plan_phase_order:, + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. adjustment_intervals:, + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. auto_collection:, billing_cycle_anchor_configuration:, + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. billing_cycle_day:, created_at:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. current_billing_period_start_date:, + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. customer:, + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. default_invoice_memo:, + # The discount intervals for this subscription sorted by the start_date. discount_intervals:, + # The date Orb stops billing for this subscription. end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, + # The maximum intervals for this subscription sorted by the start_date. maximum_intervals:, + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. metadata:, + # The minimum intervals for this subscription sorted by the start_date. minimum_intervals:, + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms:, + # A pending subscription change if one exists on this subscription. pending_subscription_change:, + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). plan:, + # The price intervals for this subscription. price_intervals:, redeemed_coupon:, + # The date Orb starts billing for this subscription. start_date:, status:, trial_info:, + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. changed_resources: nil ); end sig do @@ -363,8 +422,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end - + def self.new( + id:, + adjustment:, + # The price interval IDs that this adjustment applies to. + applies_to_price_interval_ids:, + # The end date of the adjustment interval. + end_date:, + # The start date of the adjustment interval. + start_date: + ); end sig do override .returns( @@ -431,10 +498,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. usage_discount:, adjustment_type: :usage_discount ); end @@ -498,10 +572,17 @@ module Orb end def self.new( id:, + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. amount_discount:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :amount_discount ); end @@ -565,10 +646,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. percentage_discount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :percentage_discount ); end @@ -637,11 +725,19 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The item ID that revenue from this minimum will be attributed to. item_id:, + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. minimum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :minimum ); end @@ -706,10 +802,17 @@ module Orb end def self.new( id:, + # The price IDs that this adjustment applies to. applies_to_price_ids:, + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. is_invoice_level:, + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. maximum_amount:, + # The plan phase in which this adjustment is active. plan_phase_order:, + # The reason for the adjustment. reason:, adjustment_type: :maximum ); end @@ -762,8 +865,20 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil); end - + def self.new( + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + day:, + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + month: nil, + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + year: nil + ); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } def to_hash; end end @@ -807,10 +922,15 @@ module Orb .returns(T.attached_class) end def self.new( + # Only available if discount_type is `amount`. amount_discount:, + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, discount_type: :amount ); end @@ -867,10 +987,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. percentage_discount:, + # The start date of the discount interval. start_date:, discount_type: :percentage ); end @@ -927,10 +1053,16 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this discount interval applies to. applies_to_price_ids:, + # The price interval ids that this discount interval applies to. applies_to_price_interval_ids:, + # The end date of the discount interval. end_date:, + # The start date of the discount interval. start_date:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for usage_discount:, discount_type: :usage ); end @@ -1017,14 +1149,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this maximum interval applies to. applies_to_price_ids:, + # The price interval ids that this maximum interval applies to. applies_to_price_interval_ids:, + # The end date of the maximum interval. end_date:, + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. maximum_amount:, + # The start date of the maximum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1073,14 +1209,18 @@ module Orb .returns(T.attached_class) end def self.new( + # The price ids that this minimum interval applies to. applies_to_price_ids:, + # The price interval ids that this minimum interval applies to. applies_to_price_interval_ids:, + # The end date of the minimum interval. end_date:, + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. minimum_amount:, + # The start date of the minimum interval. start_date: - ) - end - + ); end sig do override .returns( @@ -1261,14 +1401,40 @@ module Orb end def self.new( id:, + # The day of the month that Orb bills for this price billing_cycle_day:, + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. current_billing_period_end_date:, + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. current_billing_period_start_date:, + # The end date of the price interval. This is the date that Orb stops billing for + # this price. end_date:, + # An additional filter to apply to usage queries. filter:, + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. fixed_fee_quantity_transitions:, + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) price:, + # The start date of the price interval. This is the date that Orb starts billing + # for this price. start_date:, + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. usage_customer_ids: ); end sig do @@ -1362,8 +1528,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUpdateTrialResponse::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionUpdateTrialResponse::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let(:active, Orb::Models::SubscriptionUpdateTrialResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionUpdateTrialResponse::Status::TaggedSymbol) @@ -1413,8 +1578,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end - + def self.new( + # The credit notes that were created as part of this operation. + created_credit_notes:, + # The invoices that were created as part of this operation. + created_invoices:, + # The credit notes that were voided as part of this operation. + voided_credit_notes:, + # The invoices that were voided as part of this operation. + voided_invoices: + ); end sig do override .returns( diff --git a/rbi/lib/orb/models/subscription_usage.rbi b/rbi/lib/orb/models/subscription_usage.rbi index 7944b3e0..38dab0bd 100644 --- a/rbi/lib/orb/models/subscription_usage.rbi +++ b/rbi/lib/orb/models/subscription_usage.rbi @@ -104,14 +104,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } PERIODIC = T.let(:periodic, Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode::TaggedSymbol) @@ -275,14 +268,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } PERIODIC = T.let(:periodic, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode::TaggedSymbol) diff --git a/rbi/lib/orb/models/trial_discount.rbi b/rbi/lib/orb/models/trial_discount.rbi index cb8e2a48..8a2fc99a 100644 --- a/rbi/lib/orb/models/trial_discount.rbi +++ b/rbi/lib/orb/models/trial_discount.rbi @@ -33,10 +33,14 @@ module Orb .returns(T.attached_class) end def self.new( + # List of price_ids that this discount applies to. For plan/plan phase discounts, + # this can be a subset of prices. applies_to_price_ids:, discount_type:, reason: nil, + # Only available if discount_type is `trial` trial_amount_discount: nil, + # Only available if discount_type is `trial` trial_percentage_discount: nil ); end sig do @@ -57,7 +61,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::TrialDiscount::DiscountType) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::TrialDiscount::DiscountType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } TRIAL = T.let(:trial, Orb::Models::TrialDiscount::DiscountType::TaggedSymbol) diff --git a/rbi/lib/orb/models/usage_discount.rbi b/rbi/lib/orb/models/usage_discount.rbi index a91b5f1e..04792b8a 100644 --- a/rbi/lib/orb/models/usage_discount.rbi +++ b/rbi/lib/orb/models/usage_discount.rbi @@ -28,8 +28,16 @@ module Orb ) .returns(T.attached_class) end - def self.new(applies_to_price_ids:, discount_type:, usage_discount:, reason: nil); end - + def self.new( + # List of price_ids that this discount applies to. For plan/plan phase discounts, + # this can be a subset of prices. + applies_to_price_ids:, + discount_type:, + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for + usage_discount:, + reason: nil + ); end sig do override .returns( @@ -47,7 +55,7 @@ module Orb extend Orb::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::UsageDiscount::DiscountType) } - OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::UsageDiscount::DiscountType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } USAGE = T.let(:usage, Orb::Models::UsageDiscount::DiscountType::TaggedSymbol) diff --git a/sig/orb/file_part.rbs b/sig/orb/file_part.rbs new file mode 100644 index 00000000..e151025e --- /dev/null +++ b/sig/orb/file_part.rbs @@ -0,0 +1,21 @@ +module Orb + class FilePart + attr_reader content: Pathname | StringIO | IO | String + + attr_reader content_type: String? + + attr_reader filename: String? + + private def read: -> String + + def to_json: (*top a) -> String + + def to_yaml: (*top a) -> String + + def initialize: ( + Pathname | StringIO | IO | String content, + ?filename: String?, + ?content_type: String? + ) -> void + end +end diff --git a/sig/orb/internal/transport/base_client.rbs b/sig/orb/internal/transport/base_client.rbs index ebffec90..1de9a2f3 100644 --- a/sig/orb/internal/transport/base_client.rbs +++ b/sig/orb/internal/transport/base_client.rbs @@ -11,7 +11,10 @@ module Orb | Integer | ::Array[(String | Integer)?])?]?, body: top?, - unwrap: Symbol?, + unwrap: (Symbol + | Integer + | ::Array[(Symbol | Integer)] + | (^(top arg0) -> top))?, page: Class?, stream: Class?, model: Orb::Internal::Type::Converter::input?, @@ -53,7 +56,7 @@ module Orb ) -> void # @api private - attr_accessor requester: Orb::Internal::Transport::PooledNetRequester + attr_reader requester: Orb::Internal::Transport::PooledNetRequester def initialize: ( base_url: String, @@ -96,7 +99,10 @@ module Orb | Integer | ::Array[(String | Integer)?])?]?, ?body: top?, - ?unwrap: Symbol?, + ?unwrap: (Symbol + | Integer + | ::Array[(Symbol | Integer)] + | (^(top arg0) -> top))?, ?page: Class?, ?stream: Class?, ?model: Orb::Internal::Type::Converter::input?, diff --git a/sig/orb/internal/type/array_of.rbs b/sig/orb/internal/type/array_of.rbs index 20dac6aa..b16e945c 100644 --- a/sig/orb/internal/type/array_of.rbs +++ b/sig/orb/internal/type/array_of.rbs @@ -15,6 +15,8 @@ module Orb def ==: (top other) -> bool + def hash: -> Integer + def coerce: ( ::Array[top] | top value, state: Orb::Internal::Type::Converter::coerce_state diff --git a/sig/orb/internal/type/base_model.rbs b/sig/orb/internal/type/base_model.rbs index 709d39bb..a1e4a8ad 100644 --- a/sig/orb/internal/type/base_model.rbs +++ b/sig/orb/internal/type/base_model.rbs @@ -49,8 +49,12 @@ module Orb def self.==: (top other) -> bool + def self.hash: -> Integer + def ==: (top other) -> bool + def hash: -> Integer + def self.coerce: ( Orb::Internal::Type::BaseModel | ::Hash[top, top] | top value, state: Orb::Internal::Type::Converter::coerce_state diff --git a/sig/orb/internal/type/enum.rbs b/sig/orb/internal/type/enum.rbs index f87e8c1d..9917e708 100644 --- a/sig/orb/internal/type/enum.rbs +++ b/sig/orb/internal/type/enum.rbs @@ -6,12 +6,12 @@ module Orb 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: Orb::Internal::Type::Converter::coerce_state diff --git a/sig/orb/internal/type/io_like.rbs b/sig/orb/internal/type/file_input.rbs similarity index 96% rename from sig/orb/internal/type/io_like.rbs rename to sig/orb/internal/type/file_input.rbs index 11db22d6..c60545a7 100644 --- a/sig/orb/internal/type/io_like.rbs +++ b/sig/orb/internal/type/file_input.rbs @@ -1,7 +1,7 @@ module Orb module Internal module Type - class IOLike + class FileInput extend Orb::Internal::Type::Converter def self.===: (top other) -> bool diff --git a/sig/orb/internal/type/hash_of.rbs b/sig/orb/internal/type/hash_of.rbs index 014ffc68..61e26ef1 100644 --- a/sig/orb/internal/type/hash_of.rbs +++ b/sig/orb/internal/type/hash_of.rbs @@ -15,6 +15,8 @@ module Orb def ==: (top other) -> bool + def hash: -> Integer + def coerce: ( ::Hash[top, top] | top value, state: Orb::Internal::Type::Converter::coerce_state diff --git a/sig/orb/internal/type/union.rbs b/sig/orb/internal/type/union.rbs index e907f7a9..040cfc8e 100644 --- a/sig/orb/internal/type/union.rbs +++ b/sig/orb/internal/type/union.rbs @@ -30,6 +30,8 @@ module Orb def ==: (top other) -> bool + def hash: -> Integer + def coerce: ( top value, state: Orb::Internal::Type::Converter::coerce_state diff --git a/sig/orb/internal/util.rbs b/sig/orb/internal/util.rbs index 1488744e..d9560cf0 100644 --- a/sig/orb/internal/util.rbs +++ b/sig/orb/internal/util.rbs @@ -29,8 +29,10 @@ module Orb def self?.dig: ( ::Hash[Symbol, top] | ::Array[top] | top data, - (Symbol | Integer | ::Array[(Symbol | Integer)])? pick, - ?top? sentinel + (Symbol + | Integer + | ::Array[(Symbol | Integer)] + | (^(top arg0) -> top))? pick ) { -> top? } -> top? @@ -73,16 +75,6 @@ module Orb | ::Array[(String | Integer)?])?] headers ) -> ::Hash[String, String] - class SerializationAdapter - attr_reader inner: Pathname | IO - - def to_json: (*top a) -> String - - def to_yaml: (*top a) -> String - - def initialize: (Pathname | IO inner) -> void - end - class ReadIOAdapter def close?: -> bool? @@ -103,6 +95,16 @@ module Orb (Enumerator::Yielder y) -> void } -> Enumerable[String] + JSON_CONTENT: Regexp + JSONL_CONTENT: Regexp + + def self?.write_multipart_content: ( + Enumerator::Yielder y, + val: top, + closing: ::Array[^-> void], + ?content_type: String? + ) -> void + def self?.write_multipart_chunk: ( Enumerator::Yielder y, boundary: String, diff --git a/test/orb/client_test.rb b/test/orb/client_test.rb index c90a07d1..5cdabd6a 100644 --- a/test/orb/client_test.rb +++ b/test/orb/client_test.rb @@ -3,12 +3,33 @@ require_relative "test_helper" class OrbTest < Minitest::Test + include WebMock::API + + class << self + def test_order = :random + + def run_one_method(...) = Minitest::Runnable.run_one_method(...) + end + + def before_all + super + WebMock.enable! + end + def setup + super Thread.current.thread_variable_set(:mock_sleep, []) end def teardown Thread.current.thread_variable_set(:mock_sleep, nil) + WebMock.reset! + super + end + + def after_all + WebMock.disable! + super end def test_raises_on_missing_non_nullable_opts @@ -18,103 +39,79 @@ def test_raises_on_missing_non_nullable_opts assert_match(/is required/, e.message) end - class MockRequester - # @return [Integer] - attr_reader :response_code - - # @return [Hash{String=>String}] - attr_reader :response_headers - - # @return [Object] - attr_reader :response_data - - # @return [ArrayObject}>] - attr_accessor :attempts - - # @param response_code [Integer] - # @param response_headers [Hash{String=>String}] - # @param response_data [Object] - def initialize(response_code, response_headers, response_data) - @response_code = response_code - @response_headers = response_headers - @response_data = JSON.fast_generate(response_data) - @attempts = [] - end - - # @param req [Hash{Symbol=>Object}] - def execute(req) - # Deep copy the request because it is mutated on each retry. - attempts.push(Marshal.load(Marshal.dump(req))) - headers = {"content-type" => "application/json", **response_headers} - [response_code, headers, response_data.grapheme_clusters] - end - end - def test_client_default_request_default_retry_attempts - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(500, {}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json(status: 500, body: {}) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Orb::Errors::InternalServerError) do orb.customers.create(email: "dev@stainless.com", name: "x") end - assert_equal(3, requester.attempts.length) + assert_requested(:any, /./, times: 3) end def test_client_given_request_default_retry_attempts - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key", max_retries: 3) - requester = MockRequester.new(500, {}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json(status: 500, body: {}) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 3) assert_raises(Orb::Errors::InternalServerError) do orb.customers.create(email: "dev@stainless.com", name: "x") end - assert_equal(4, requester.attempts.length) + assert_requested(:any, /./, times: 4) end def test_client_default_request_given_retry_attempts - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(500, {}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json(status: 500, body: {}) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Orb::Errors::InternalServerError) do orb.customers.create(email: "dev@stainless.com", name: "x", request_options: {max_retries: 3}) end - assert_equal(4, requester.attempts.length) + assert_requested(:any, /./, times: 4) end def test_client_given_request_given_retry_attempts - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key", max_retries: 3) - requester = MockRequester.new(500, {}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json(status: 500, body: {}) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 3) assert_raises(Orb::Errors::InternalServerError) do orb.customers.create(email: "dev@stainless.com", name: "x", request_options: {max_retries: 4}) end - assert_equal(5, requester.attempts.length) + assert_requested(:any, /./, times: 5) end def test_client_retry_after_seconds - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key", max_retries: 1) - requester = MockRequester.new(500, {"retry-after" => "1.3"}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json( + status: 500, + headers: {"retry-after" => "1.3"}, + body: {} + ) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 1) assert_raises(Orb::Errors::InternalServerError) do orb.customers.create(email: "dev@stainless.com", name: "x") end - assert_equal(2, requester.attempts.length) + assert_requested(:any, /./, times: 2) assert_equal(1.3, Thread.current.thread_variable_get(:mock_sleep).last) end def test_client_retry_after_date - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key", max_retries: 1) - requester = MockRequester.new(500, {"retry-after" => (Time.now + 10).httpdate}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json( + status: 500, + headers: {"retry-after" => (Time.now + 10).httpdate}, + body: {} + ) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 1) assert_raises(Orb::Errors::InternalServerError) do Thread.current.thread_variable_set(:time_now, Time.now) @@ -122,43 +119,45 @@ def test_client_retry_after_date Thread.current.thread_variable_set(:time_now, nil) end - assert_equal(2, requester.attempts.length) + assert_requested(:any, /./, times: 2) assert_in_delta(10, Thread.current.thread_variable_get(:mock_sleep).last, 1.0) end def test_client_retry_after_ms - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key", max_retries: 1) - requester = MockRequester.new(500, {"retry-after-ms" => "1300"}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json( + status: 500, + headers: {"retry-after-ms" => "1300"}, + body: {} + ) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 1) assert_raises(Orb::Errors::InternalServerError) do orb.customers.create(email: "dev@stainless.com", name: "x") end - assert_equal(2, requester.attempts.length) + assert_requested(:any, /./, times: 2) assert_equal(1.3, Thread.current.thread_variable_get(:mock_sleep).last) end def test_retry_count_header - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(500, {}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json(status: 500, body: {}) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Orb::Errors::InternalServerError) do orb.customers.create(email: "dev@stainless.com", name: "x") end - retry_count_headers = requester.attempts.map do - _1.fetch(:headers).fetch("x-stainless-retry-count") + 3.times do + assert_requested(:any, /./, headers: {"x-stainless-retry-count" => _1}) end - - assert_equal(%w[0 1 2], retry_count_headers) end def test_omit_retry_count_header - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(500, {}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json(status: 500, body: {}) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Orb::Errors::InternalServerError) do orb.customers.create( @@ -168,17 +167,15 @@ def test_omit_retry_count_header ) end - retry_count_headers = requester.attempts.map do - _1.fetch(:headers).fetch("x-stainless-retry-count", nil) + assert_requested(:any, /./, times: 3) do + refute_includes(_1.headers.keys.map(&:downcase), "x-stainless-retry-count") end - - assert_equal([nil, nil, nil], retry_count_headers) end def test_overwrite_retry_count_header - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(500, {}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json(status: 500, body: {}) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Orb::Errors::InternalServerError) do orb.customers.create( @@ -188,50 +185,74 @@ def test_overwrite_retry_count_header ) end - retry_count_headers = requester.attempts.map do - _1.fetch(:headers).fetch("x-stainless-retry-count") - end - - assert_equal(%w[42 42 42], retry_count_headers) + assert_requested(:any, /./, headers: {"x-stainless-retry-count" => "42"}, times: 3) end def test_client_redirect_307 - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(307, {"location" => "/redirected"}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json( + status: 307, + headers: {"location" => "/redirected"}, + body: {} + ) + stub_request(:any, "http://localhost/redirected").to_return( + status: 307, + headers: {"location" => "/redirected"} + ) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Orb::Errors::APIConnectionError) do orb.customers.create(email: "dev@stainless.com", name: "x", request_options: {extra_headers: {}}) end - assert_equal("/redirected", requester.attempts.last.fetch(:url).path) - assert_equal(requester.attempts.first.fetch(:method), requester.attempts.last.fetch(:method)) - assert_equal(requester.attempts.first.fetch(:body), requester.attempts.last.fetch(:body)) - assert_equal( - requester.attempts.first.fetch(:headers)["content-type"], - requester.attempts.last.fetch(:headers)["content-type"] - ) + recorded, = WebMock::RequestRegistry.instance.requested_signatures.hash.first + + assert_requested(:any, "http://localhost/redirected", times: Orb::Client::MAX_REDIRECTS) do + assert_equal(recorded.method, _1.method) + assert_equal(recorded.body, _1.body) + assert_equal( + recorded.headers.transform_keys(&:downcase).fetch("content-type"), + _1.headers.transform_keys(&:downcase).fetch("content-type") + ) + end end def test_client_redirect_303 - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(303, {"location" => "/redirected"}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json( + status: 303, + headers: {"location" => "/redirected"}, + body: {} + ) + stub_request(:get, "http://localhost/redirected").to_return( + status: 303, + headers: {"location" => "/redirected"} + ) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Orb::Errors::APIConnectionError) do orb.customers.create(email: "dev@stainless.com", name: "x", request_options: {extra_headers: {}}) end - assert_equal("/redirected", requester.attempts.last.fetch(:url).path) - assert_equal(:get, requester.attempts.last.fetch(:method)) - assert_nil(requester.attempts.last.fetch(:body)) - assert_nil(requester.attempts.last.fetch(:headers)["content-type"]) + assert_requested(:get, "http://localhost/redirected", times: Orb::Client::MAX_REDIRECTS) do + headers = _1.headers.keys.map(&:downcase) + refute_includes(headers, "content-type") + assert_nil(_1.body) + end end def test_client_redirect_auth_keep_same_origin - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(307, {"location" => "/redirected"}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json( + status: 307, + headers: {"location" => "/redirected"}, + body: {} + ) + stub_request(:any, "http://localhost/redirected").to_return( + status: 307, + headers: {"location" => "/redirected"} + ) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Orb::Errors::APIConnectionError) do orb.customers.create( @@ -241,16 +262,28 @@ def test_client_redirect_auth_keep_same_origin ) end - assert_equal( - requester.attempts.first.fetch(:headers)["authorization"], - requester.attempts.last.fetch(:headers)["authorization"] - ) + recorded, = WebMock::RequestRegistry.instance.requested_signatures.hash.first + auth_header = recorded.headers.transform_keys(&:downcase).fetch("authorization") + + assert_equal("Bearer xyz", auth_header) + assert_requested(:any, "http://localhost/redirected", times: Orb::Client::MAX_REDIRECTS) do + auth_header = _1.headers.transform_keys(&:downcase).fetch("authorization") + assert_equal("Bearer xyz", auth_header) + end end def test_client_redirect_auth_strip_cross_origin - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(307, {"location" => "https://example.com/redirected"}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json( + status: 307, + headers: {"location" => "https://example.com/redirected"}, + body: {} + ) + stub_request(:any, "https://example.com/redirected").to_return( + status: 307, + headers: {"location" => "https://example.com/redirected"} + ) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Orb::Errors::APIConnectionError) do orb.customers.create( @@ -260,31 +293,35 @@ def test_client_redirect_auth_strip_cross_origin ) end - assert_nil(requester.attempts.last.fetch(:headers)["authorization"]) + assert_requested(:any, "https://example.com/redirected", times: Orb::Client::MAX_REDIRECTS) do + headers = _1.headers.keys.map(&:downcase) + refute_includes(headers, "authorization") + end end def test_client_default_idempotency_key_on_writes - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(500, {}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json(status: 500, body: {}) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Orb::Errors::InternalServerError) do orb.customers.create(email: "dev@stainless.com", name: "x", request_options: {max_retries: 1}) end - idempotency_headers = requester.attempts.map do - _1.fetch(:headers).fetch("idempotency-key") + headers = [] + assert_requested(:any, /./, times: 2) do + header = _1.headers.transform_keys(&:downcase).fetch("idempotency-key") + headers << header + refute_empty(header) end - assert_kind_of(String, idempotency_headers.first) - refute_empty(idempotency_headers.first) - assert_equal(idempotency_headers.first, idempotency_headers.last) + assert_equal(*headers) end def test_request_option_idempotency_key_on_writes - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(500, {}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json(status: 500, body: {}) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key") assert_raises(Orb::Errors::InternalServerError) do orb.customers.create( @@ -294,19 +331,24 @@ def test_request_option_idempotency_key_on_writes ) end - requester.attempts.each do - assert_equal("user-supplied-key", _1.fetch(:headers).fetch("idempotency-key")) - end + assert_requested( + :any, + /./, + headers: {"idempotency-key" => "user-supplied-key"}, + times: 2 + ) end def test_default_headers - orb = Orb::Client.new(base_url: "http://localhost:4010", api_key: "My API Key") - requester = MockRequester.new(200, {}, {}) - orb.requester = requester + stub_request(:post, "http://localhost/customers").to_return_json(status: 200, body: {}) + + orb = Orb::Client.new(base_url: "http://localhost", api_key: "My API Key") + orb.customers.create(email: "dev@stainless.com", name: "x") - headers = requester.attempts.first.fetch(:headers) - refute_empty(headers["accept"]) - refute_empty(headers["content-type"]) + assert_requested(:any, /./) do |req| + headers = req.headers.transform_keys(&:downcase).fetch_values("accept", "content-type") + headers.each { refute_empty(_1) } + end end end diff --git a/test/orb/file_part_test.rb b/test/orb/file_part_test.rb new file mode 100644 index 00000000..f405352f --- /dev/null +++ b/test/orb/file_part_test.rb @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +require_relative "test_helper" + +class Orb::Test::FilePartTest < Minitest::Test + def test_to_json + text = "gray" + filepart = Orb::FilePart.new(StringIO.new(text)) + + assert_equal(text.to_json, filepart.to_json) + end +end diff --git a/test/orb/internal/type/base_model_test.rb b/test/orb/internal/type/base_model_test.rb index d33e2616..88f9e458 100644 --- a/test/orb/internal/type/base_model_test.rb +++ b/test/orb/internal/type/base_model_test.rb @@ -94,7 +94,7 @@ def test_dump [:a, :b] => :b, [:a, "a"] => "a", [String, StringIO.new("one")] => "one", - [String, Pathname(__FILE__)] => Orb::Internal::Util::SerializationAdapter + [String, Pathname(__FILE__)] => Orb::FilePart } cases.each do @@ -156,6 +156,7 @@ def test_dump_retry class Orb::Test::EnumModelTest < Minitest::Test class E0 include Orb::Internal::Type::Enum + attr_reader :values def initialize(*values) = (@values = values) end @@ -575,6 +576,7 @@ def test_coerce class Orb::Test::BaseModelQoLTest < Minitest::Test class E0 include Orb::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/orb/internal/util_test.rb b/test/orb/internal/util_test.rb index 5c8a2a37..440481d0 100644 --- a/test/orb/internal/util_test.rb +++ b/test/orb/internal/util_test.rb @@ -87,8 +87,9 @@ def test_dig Orb::Internal::Util.dig([], 1.0) => nil Orb::Internal::Util.dig(Object, 1) => nil - Orb::Internal::Util.dig([], 1.0, 2) => 2 Orb::Internal::Util.dig([], 1.0) { 2 } => 2 + Orb::Internal::Util.dig([], ->(_) { 2 }) => 2 + Orb::Internal::Util.dig([1], -> { _1 in [1] }) => true end end end @@ -157,6 +158,22 @@ def test_joining_queries end end +class Orb::Test::RegexMatchTest < Minitest::Test + def test_json_content + cases = { + "application/json" => true, + "application/jsonl" => false, + "application/vnd.github.v3+json" => true, + "application/vnd.api+json" => true + } + cases.each do |header, verdict| + assert_pattern do + Orb::Internal::Util::JSON_CONTENT.match?(header) => ^verdict + end + end + end +end + class Orb::Test::UtilFormDataEncodingTest < Minitest::Test class FakeCGI < CGI def initialize(headers, io) @@ -184,8 +201,12 @@ def test_file_encode file = Pathname(__FILE__) headers = {"content-type" => "multipart/form-data"} cases = { + "abc" => "abc", StringIO.new("abc") => "abc", - file => /^class Orb/ + Orb::FilePart.new("abc") => "abc", + Orb::FilePart.new(StringIO.new("abc")) => "abc", + file => /^class Orb/, + Orb::FilePart.new(file) => /^class Orb/ } cases.each do |body, val| encoded = Orb::Internal::Util.encode_content(headers, body) @@ -203,7 +224,9 @@ def test_hash_encode {a: 2, b: nil} => {"a" => "2", "b" => "null"}, {a: 2, b: [1, 2, 3]} => {"a" => "2", "b" => "1"}, {strio: StringIO.new("a")} => {"strio" => "a"}, - {pathname: Pathname(__FILE__)} => {"pathname" => -> { _1.read in /^class Orb/ }} + {strio: Orb::FilePart.new("a")} => {"strio" => "a"}, + {pathname: Pathname(__FILE__)} => {"pathname" => -> { _1.read in /^class Orb/ }}, + {pathname: Orb::FilePart.new(Pathname(__FILE__))} => {"pathname" => -> { _1.read in /^class Orb/ }} } cases.each do |body, testcase| encoded = Orb::Internal::Util.encode_content(headers, body) diff --git a/test/orb/test_helper.rb b/test/orb/test_helper.rb index 5f3c75b6..47d42e2b 100644 --- a/test/orb/test_helper.rb +++ b/test/orb/test_helper.rb @@ -15,6 +15,7 @@ require "minitest/hooks/test" require "minitest/proveit" require "minitest/rg" +require "webmock" require_relative "../../lib/orb" require_relative "resource_namespaces" @@ -44,8 +45,10 @@ def self.now = Thread.current.thread_variable_get(:time_now) || _now class Orb::Test::SingletonClient < Orb::Client include Singleton + TEST_API_BASE_URL = ENV.fetch("TEST_API_BASE_URL", "http://localhost:4010") + def initialize - super(base_url: ENV.fetch("TEST_API_BASE_URL", "http://localhost:4010"), api_key: "My API Key") + super(base_url: Orb::Test::SingletonClient::TEST_API_BASE_URL, api_key: "My API Key") end end @@ -72,3 +75,7 @@ def around_all = async? ? Sync { super } : super def around = async? ? Async { super }.wait : super end + +module WebMock + AssertionFailure.error_class = Minitest::Assertion +end