diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 3b005e52..ee49ac2d 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0-alpha.10" + ".": "0.1.0-alpha.11" } \ No newline at end of file diff --git a/.rubocop.yml b/.rubocop.yml index fd275e74..bfe086f9 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -1,15 +1,14 @@ --- - # Explicitly disable pending cops for now. This is the default behaviour but # this avoids a large warning every time we run it. # Stop RuboCop nagging about rubocop-rake. # Ensure that RuboCop validates according to the lowest version of Ruby that we support. AllCops: - Exclude: + Exclude: - "bin/*" NewCops: enable SuggestExtensions: false - TargetRubyVersion: 3.0.0 + TargetRubyVersion: 3.1.0 # Don't require this extra line break, it can be excessive. Layout/EmptyLineAfterGuardClause: @@ -33,7 +32,7 @@ Layout/FirstMethodParameterLineBreak: # Set a reasonable line length; rely on other cops to correct long lines. Layout/LineLength: - AllowedPatterns: + AllowedPatterns: - "^\\s*#.*$" - ^require(_relative)? - "Orb::(Models|Resources)::" @@ -59,14 +58,14 @@ Layout/MultilineMethodParameterLineBreaks: Layout/SpaceInsideHashLiteralBraces: EnforcedStyle: no_space -Lint/ConstantDefinitionInBlock: - Exclude: - - "lib/**/*" - Lint/MissingSuper: - Exclude: + Exclude: - "**/*.rbi" +# Disabled for safety reasons, this option changes code semantics. +Lint/UnusedMethodArgument: + AutoCorrect: false + Metrics/AbcSize: Enabled: false @@ -85,8 +84,12 @@ Metrics/ParameterLists: Metrics/PerceivedComplexity: Enabled: false +Naming/BlockForwarding: + Exclude: + - "**/*.rbi" + Naming/MethodParameterName: - Exclude: + Exclude: - "**/*.rbi" Naming/VariableNumber: @@ -97,7 +100,7 @@ Style/AccessModifierDeclarations: Enabled: false Style/AccessorGrouping: - Exclude: + Exclude: - "**/*.rbi" # Behaviour of alias_method is more predictable. @@ -109,17 +112,17 @@ Style/AndOr: EnforcedStyle: always Style/BisectedAttrAccessor: - Exclude: + Exclude: - "**/*.rbi" # Fairly useful in tests for pattern matching. Style/CaseEquality: - Exclude: + Exclude: - "test/**/*" # We prefer nested modules in lib/, but are currently using compact style for tests. Style/ClassAndModuleChildren: - Exclude: + Exclude: - "test/**/*" # We should go back and add these docs, but ignore for now. @@ -131,7 +134,7 @@ Style/EmptyElse: Enabled: false Style/EmptyMethod: - Exclude: + Exclude: - "**/*.rbi" # We commonly use ENV['KEY'], it's OK. @@ -141,7 +144,7 @@ Style/FetchEnvVar: # Just to be safe, ensure nobody is mutating our internal strings. Style/FrozenStringLiteralComment: EnforcedStyle: always - Exclude: + Exclude: - "**/*.rbi" # Nothing wrong with clear if statements. @@ -154,10 +157,10 @@ Style/Lambda: # Prefer consistency in method calling syntax. Style/MethodCallWithArgsParentheses: - AllowedMethods: + AllowedMethods: - raise Enabled: true - Exclude: + Exclude: - "**/*.gemspec" # Perfectly fine. @@ -165,7 +168,7 @@ Style/MultipleComparison: Enabled: false Style/MutableConstant: - Exclude: + Exclude: - "**/*.rbi" # Not all parameters should be named. @@ -181,7 +184,7 @@ Style/RedundantException: Enabled: false Style/RedundantInitialize: - Exclude: + Exclude: - "**/*.rbi" # Prefer slashes for regex literals. diff --git a/.stats.yml b/.stats.yml index 3599ce86..a16642c4 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,2 +1,2 @@ configured_endpoints: 103 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-7791652a23b1ed216bba0b8fa77798252f78b0525fbd77cc29ee92c6d5739c5a.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-99ab2def905df4700d0555a61c3e6f3e378664df85756fc0ff604aed8f8c5f8b.yml diff --git a/CHANGELOG.md b/CHANGELOG.md index 768c17f0..7e9a19b2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,22 @@ # Changelog +## 0.1.0-alpha.11 (2025-02-20) + +Full Changelog: [v0.1.0-alpha.10...v0.1.0-alpha.11](https://github.com/orbcorp/orb-ruby/compare/v0.1.0-alpha.10...v0.1.0-alpha.11) + +### Features + +* **api:** api update ([#58](https://github.com/orbcorp/orb-ruby/issues/58)) ([c583464](https://github.com/orbcorp/orb-ruby/commit/c583464a5a4f8b4c5cb5e478d784452300a43976)) + + +### Chores + +* **internal:** codegen related update ([#55](https://github.com/orbcorp/orb-ruby/issues/55)) ([b4c2f83](https://github.com/orbcorp/orb-ruby/commit/b4c2f83f13f7728839247370d0302fbbccbe61f4)) +* **internal:** codegen related update ([#56](https://github.com/orbcorp/orb-ruby/issues/56)) ([0743711](https://github.com/orbcorp/orb-ruby/commit/0743711518c96c53eb3f048368e438c6d75694a2)) +* **internal:** codegen related update ([#59](https://github.com/orbcorp/orb-ruby/issues/59)) ([b543b0e](https://github.com/orbcorp/orb-ruby/commit/b543b0e32f6f249481e163d3571d6b158eaafb95)) +* **internal:** version bump ([#53](https://github.com/orbcorp/orb-ruby/issues/53)) ([da269bc](https://github.com/orbcorp/orb-ruby/commit/da269bcc0d4cbe139dca3dc4ad6d4f694e2227af)) +* reorganize import ordering ([#60](https://github.com/orbcorp/orb-ruby/issues/60)) ([aee7303](https://github.com/orbcorp/orb-ruby/commit/aee73038273f61eec76466f5630b07f06ba151e7)) + ## 0.1.0-alpha.10 (2025-02-20) Full Changelog: [v0.1.0-alpha.9...v0.1.0-alpha.10](https://github.com/orbcorp/orb-ruby/compare/v0.1.0-alpha.9...v0.1.0-alpha.10) diff --git a/Gemfile.lock b/Gemfile.lock index 11cdb76f..5e2e3863 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - orb (0.1.0.pre.alpha.10) + orb (0.1.0.pre.alpha.11) connection_pool GEM diff --git a/lib/orb.rb b/lib/orb.rb index 9aaffd19..360d0e13 100644 --- a/lib/orb.rb +++ b/lib/orb.rb @@ -17,15 +17,17 @@ require "connection_pool" # Package files. -require_relative "orb/pooled_net_requester" require_relative "orb/version" require_relative "orb/util" require_relative "orb/extern" require_relative "orb/base_model" require_relative "orb/base_page" require_relative "orb/request_options" -require_relative "orb/base_client" require_relative "orb/errors" +require_relative "orb/base_client" +require_relative "orb/pooled_net_requester" +require_relative "orb/client" +require_relative "orb/page" require_relative "orb/models/amount_discount" require_relative "orb/models/billing_cycle_relative_date" require_relative "orb/models/discount" @@ -191,8 +193,6 @@ require_relative "orb/models/dimensional_price_group_retrieve_params" require_relative "orb/models/dimensional_price_group_list_params" require_relative "orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params" -require_relative "orb/client" -require_relative "orb/page" require_relative "orb/resources/top_level" require_relative "orb/resources/coupons" require_relative "orb/resources/coupons/subscriptions" diff --git a/lib/orb/base_client.rb b/lib/orb/base_client.rb index 1bacb335..8ea9e740 100644 --- a/lib/orb/base_client.rb +++ b/lib/orb/base_client.rb @@ -9,23 +9,117 @@ class BaseClient # from whatwg fetch spec MAX_REDIRECTS = 20 - # @private - # - # @param req [Hash{Symbol=>Object}] - # - # @raise [ArgumentError] - # - def self.validate!(req) - keys = [:method, :path, :query, :headers, :body, :unwrap, :page, :model, :options] - case req - in Hash - req.each_key do |k| - unless keys.include?(k) - raise ArgumentError.new("Request `req` keys must be one of #{keys}, got #{k.inspect}") + class << self + # @private + # + # @param req [Hash{Symbol=>Object}] + # + # @raise [ArgumentError] + # + def validate!(req) + keys = [:method, :path, :query, :headers, :body, :unwrap, :page, :model, :options] + case req + in Hash + req.each_key do |k| + unless keys.include?(k) + raise ArgumentError.new("Request `req` keys must be one of #{keys}, got #{k.inspect}") + end end + else + raise ArgumentError.new("Request `req` must be a Hash or RequestOptions, got #{req.inspect}") + end + end + + # @private + # + # @param status [Integer] + # @param headers [Hash{String=>String}, Net::HTTPHeader] + # + # @return [Boolean] + # + def should_retry?(status, headers:) + coerced = Orb::Util.coerce_boolean(headers["x-should-retry"]) + case [coerced, status] + in [true | false, _] + coerced + in [_, 408 | 409 | 429 | (500..)] + # retry on: + # 408: timeouts + # 409: locks + # 429: rate limits + # 500+: unknown errors + true + else + false + end + end + + # @private + # + # @param request [Hash{Symbol=>Object}] . + # + # @option request [Symbol] :method + # + # @option request [URI::Generic] :url + # + # @option request [Hash{String=>String}] :headers + # + # @option request [Object] :body + # + # @option request [Boolean] :streaming + # + # @option request [Integer] :max_retries + # + # @option request [Float] :timeout + # + # @param status [Integer] + # + # @param response_headers [Hash{String=>String}, Net::HTTPHeader] + # + # @return [Hash{Symbol=>Object}] + # + def follow_redirect(request, status:, response_headers:) + method, url, headers = request.fetch_values(:method, :url, :headers) + location = + Orb::Util.suppress(ArgumentError) do + URI.join(url, response_headers["location"]) + end + + unless location + message = "Server responded with status #{status} but no valid location header." + raise Orb::APIConnectionError.new(url: url, message: message) + end + + request = {**request, url: location} + + case [url.scheme, location.scheme] + in ["https", "http"] + message = "Tried to redirect to a insecure URL" + raise Orb::APIConnectionError.new(url: url, message: message) + else + nil + end + + # from whatwg fetch spec + case [status, method] + in [301 | 302, :post] | [303, _] + drop = %w[content-encoding content-language content-length content-location content-type] + request = { + **request, + method: method == :head ? :head : :get, + headers: headers.except(*drop), + body: nil + } + else end - else - raise ArgumentError.new("Request `req` must be a Hash or RequestOptions, got #{req.inspect}") + + # from undici + if Orb::Util.uri_origin(url) != Orb::Util.uri_origin(location) + drop = %w[authorization cookie host proxy-authorization] + request = {**request, headers: request.fetch(:headers).except(*drop)} + end + + request end end @@ -163,34 +257,16 @@ def initialize( Orb::Util.deep_merge(*[req[:body], opts[:extra_body]].compact) end - url = Orb::Util.join_parsed_uri(@base_url, {**req, path: path, query: query}) headers, encoded = Orb::Util.encode_content(headers, body) - max_retries = opts.fetch(:max_retries, @max_retries) - {method: method, url: url, headers: headers, body: encoded, max_retries: max_retries, timeout: timeout} - end - - # @private - # - # @param status [Integer] - # @param headers [Hash{String=>String}] - # - # @return [Boolean] - # - private def should_retry?(status, headers:) - coerced = Orb::Util.coerce_boolean(headers["x-should-retry"]) - case [coerced, status] - in [true | false, _] - coerced - in [_, 408 | 409 | 429 | (500..)] - # retry on: - # 408: timeouts - # 409: locks - # 429: rate limits - # 500+: unknown errors - true - else - false - end + { + method: method, + url: Orb::Util.join_parsed_uri(@base_url, {**req, path: path, query: query}), + headers: headers, + body: encoded, + streaming: false, + max_retries: opts.fetch(:max_retries, @max_retries), + timeout: timeout + } end # @private @@ -230,71 +306,7 @@ def initialize( # # @option request [Object] :body # - # @option request [Integer] :max_retries - # - # @option request [Float] :timeout - # - # @param status [Integer] - # - # @param location_header [String] - # - # @return [Hash{Symbol=>Object}] - # - private def follow_redirect(request, status:, location_header:) - method, url, headers = request.fetch_values(:method, :url, :headers) - location = - Orb::Util.suppress(ArgumentError) do - URI.join(url, location_header) - end - - unless location - message = "Server responded with status #{status} but no valid location header." - raise Orb::APIConnectionError.new(url: url, message: message) - end - - request = {**request, url: location} - - case [url.scheme, location.scheme] - in ["https", "http"] - message = "Tried to redirect to a insecure URL" - raise Orb::APIConnectionError.new(url: url, message: message) - else - nil - end - - # from whatwg fetch spec - case [status, method] - in [301 | 302, :post] | [303, _] - drop = %w[content-encoding content-language content-length content-location content-type] - request = { - **request, - method: method == :head ? :head : :get, - headers: headers.except(*drop), - body: nil - } - else - end - - # from undici - if Orb::Util.uri_origin(url) != Orb::Util.uri_origin(location) - drop = %w[authorization cookie host proxy-authorization] - request = {**request, headers: request.fetch(:headers).except(*drop)} - end - - request - end - - # @private - # - # @param request [Hash{Symbol=>Object}] . - # - # @option request [Symbol] :method - # - # @option request [URI::Generic] :url - # - # @option request [Hash{String=>String}] :headers - # - # @option request [Object] :body + # @option request [Boolean] :streaming # # @option request [Integer] :max_retries # @@ -307,18 +319,18 @@ def initialize( # @param send_retry_header [Boolean] # # @raise [Orb::APIError] - # @return [Net::HTTPResponse] + # @return [Array(Net::HTTPResponse, Enumerable)] # private def send_request(request, redirect_count:, retry_count:, send_retry_header:) - url, headers, body, max_retries = request.fetch_values(:url, :headers, :body, :max_retries) - no_retry = retry_count >= max_retries || body.is_a?(IO) || body.is_a?(StringIO) + url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout) + input = {**request.except(:timeout), deadline: Orb::Util.monotonic_secs + timeout} if send_retry_header headers["x-stainless-retry-count"] = retry_count.to_s end begin - response = @requester.execute(request) + response, stream = @requester.execute(input) status = Integer(response.code) rescue Orb::APIConnectionError => e status = e @@ -326,12 +338,12 @@ def initialize( case status in ..299 - response + [response, stream] in 300..399 if redirect_count >= MAX_REDIRECTS message = "Failed to complete the request within #{MAX_REDIRECTS} redirects." raise Orb::APIConnectionError.new(url: url, message: message) in 300..399 - request = follow_redirect(request, status: status, location_header: response["location"]) + request = self.class.follow_redirect(request, status: status, response_headers: response) send_request( request, redirect_count: redirect_count + 1, @@ -340,13 +352,16 @@ def initialize( ) in Orb::APIConnectionError if retry_count >= max_retries raise status - in (400..) if no_retry || (response && !should_retry?(status, headers: response)) - body = Orb::Util.decode_content(response, suppress_error: true) + in (400..) if retry_count >= max_retries || (response && !self.class.should_retry?( + status, + headers: response + )) + decoded = Orb::Util.decode_content(response, stream: stream, suppress_error: true) raise Orb::APIStatusError.for( url: url, status: status, - body: body, + body: decoded, request: nil, response: response ) @@ -361,6 +376,8 @@ def initialize( send_retry_header: send_retry_header ) end + ensure + stream&.each { break } unless status.is_a?(Integer) && status < 300 end # @private @@ -385,17 +402,19 @@ def initialize( # # @option req [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :options # - # @param response [nil] + # @param headers [Hash{String=>String}, Net::HTTPHeader] + # + # @param stream [Enumerable] # # @return [Object] # - private def parse_response(req, response) - parsed = Orb::Util.decode_content(response) - unwrapped = Orb::Util.dig(parsed, req[:unwrap]) + private def parse_response(req, headers:, stream:) + decoded = Orb::Util.decode_content(headers, stream: stream) + unwrapped = Orb::Util.dig(decoded, req[:unwrap]) case [req[:page], req.fetch(:model, Orb::Unknown)] in [Class => page, _] - page.new(client: self, req: req, headers: response, unwrapped: unwrapped) + page.new(client: self, req: req, headers: headers, unwrapped: unwrapped) in [nil, Class | Orb::Converter => model] Orb::Converter.coerce(model, unwrapped) in [nil, nil] @@ -433,17 +452,17 @@ def request(req) self.class.validate!(req) opts = req[:options].to_h Orb::RequestOptions.validate!(opts) - request = build_request(req, opts) + request = build_request(req.except(:options), opts) # Don't send the current retry count in the headers if the caller modified the header defaults. send_retry_header = request.fetch(:headers)["x-stainless-retry-count"] == "0" - response = send_request( + response, stream = send_request( request, redirect_count: 0, retry_count: 0, send_retry_header: send_retry_header ) - parse_response(req, response) + parse_response(req, headers: response, stream: stream) end # @return [String] diff --git a/lib/orb/base_model.rb b/lib/orb/base_model.rb index b2dc8449..d009595c 100644 --- a/lib/orb/base_model.rb +++ b/lib/orb/base_model.rb @@ -148,6 +148,8 @@ def try_strict_coerce(target, value) [true, Integer(value), 1] in [-> { _1 <= Float }, Numeric] [true, Float(value), 1] + in [-> { _1 <= Symbol }, String] + [true, value.to_sym, 1] in [-> { _1 <= String }, Symbol] [true, value.to_s, 1] in [-> { _1 <= Date || _1 <= Time }, String] diff --git a/lib/orb/base_page.rb b/lib/orb/base_page.rb index f8a32ac1..7094f8cc 100644 --- a/lib/orb/base_page.rb +++ b/lib/orb/base_page.rb @@ -6,8 +6,6 @@ module Orb # @abstract # module BasePage - # rubocop:disable Lint/UnusedMethodArgument - # @return [Boolean] # def next_page? = (raise NotImplementedError) @@ -21,7 +19,7 @@ def next_page = (raise NotImplementedError) # # @return [void] # - def auto_paging_each(&blk) = (raise NotImplementedError) + def auto_paging_each(&) = (raise NotImplementedError) # @return [Enumerable] # @@ -34,11 +32,9 @@ def to_enum = super(:auto_paging_each) # # # # @param client [Orb::BaseClient] # # @param req [Hash{Symbol=>Object}] - # # @param headers [Hash{String=>String}] + # # @param headers [Hash{String=>String}, Net::HTTPHeader] # # @param unwrapped [Object] # # # def initialize(client:, req:, headers:, unwrapped:); end - - # rubocop:enable Lint/UnusedMethodArgument end end diff --git a/lib/orb/models/alert.rb b/lib/orb/models/alert.rb index f4e835e3..75f8451c 100644 --- a/lib/orb/models/alert.rb +++ b/lib/orb/models/alert.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # alert => { - # id: String, - # created_at: Time, - # currency: String, - # customer: Orb::Models::Alert::Customer, - # enabled: Orb::BooleanModel, - # **_ - # } - # ``` class Alert < Orb::BaseModel # @!attribute id # Also referred to as alert_id in this documentation. @@ -97,13 +86,6 @@ class Alert < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -126,12 +108,6 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # metric => { - # id: String - # } - # ``` class Metric < Orb::BaseModel # @!attribute id # @@ -148,15 +124,6 @@ class Metric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan => { - # id: String, - # external_plan_id: String, - # name: String, - # plan_version: String - # } - # ``` class Plan < Orb::BaseModel # @!attribute id # @@ -194,12 +161,6 @@ class Plan < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # subscription => { - # id: String - # } - # ``` class Subscription < Orb::BaseModel # @!attribute id # @@ -216,12 +177,6 @@ class Subscription < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # threshold => { - # value: Float - # } - # ``` class Threshold < Orb::BaseModel # @!attribute value # The value at which an alert will fire. For credit balance alerts, the alert will diff --git a/lib/orb/models/alert_create_for_customer_params.rb b/lib/orb/models/alert_create_for_customer_params.rb index 8a2b6ae6..7f582e52 100644 --- a/lib/orb/models/alert_create_for_customer_params.rb +++ b/lib/orb/models/alert_create_for_customer_params.rb @@ -71,12 +71,6 @@ class Type < Orb::Enum # def self.values; end end - # @example - # ```ruby - # threshold => { - # value: Float - # } - # ``` class Threshold < Orb::BaseModel # @!attribute value # The value at which an alert will fire. For credit balance alerts, the alert will 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 1bd56f4f..54d88a2d 100644 --- a/lib/orb/models/alert_create_for_external_customer_params.rb +++ b/lib/orb/models/alert_create_for_external_customer_params.rb @@ -71,12 +71,6 @@ class Type < Orb::Enum # def self.values; end end - # @example - # ```ruby - # threshold => { - # value: Float - # } - # ``` class Threshold < Orb::BaseModel # @!attribute value # The value at which an alert will fire. For credit balance alerts, the alert will diff --git a/lib/orb/models/alert_create_for_subscription_params.rb b/lib/orb/models/alert_create_for_subscription_params.rb index 72c07c28..b03899a1 100644 --- a/lib/orb/models/alert_create_for_subscription_params.rb +++ b/lib/orb/models/alert_create_for_subscription_params.rb @@ -35,12 +35,6 @@ class AlertCreateForSubscriptionParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # threshold => { - # value: Float - # } - # ``` class Threshold < Orb::BaseModel # @!attribute value # The value at which an alert will fire. For credit balance alerts, the alert will diff --git a/lib/orb/models/alert_update_params.rb b/lib/orb/models/alert_update_params.rb index e007bc57..9a7dd021 100644 --- a/lib/orb/models/alert_update_params.rb +++ b/lib/orb/models/alert_update_params.rb @@ -21,12 +21,6 @@ class AlertUpdateParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # threshold => { - # value: Float - # } - # ``` class Threshold < Orb::BaseModel # @!attribute value # The value at which an alert will fire. For credit balance alerts, the alert will diff --git a/lib/orb/models/amount_discount.rb b/lib/orb/models/amount_discount.rb index ccb02fef..c560daa0 100644 --- a/lib/orb/models/amount_discount.rb +++ b/lib/orb/models/amount_discount.rb @@ -2,15 +2,6 @@ module Orb module Models - # @example - # ```ruby - # amount_discount => { - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: Orb::Models::AmountDiscount::DiscountType, - # reason: String - # } - # ``` class AmountDiscount < Orb::BaseModel # @!attribute amount_discount # Only available if discount_type is `amount`. diff --git a/lib/orb/models/billable_metric.rb b/lib/orb/models/billable_metric.rb index 250c1825..2cf61284 100644 --- a/lib/orb/models/billable_metric.rb +++ b/lib/orb/models/billable_metric.rb @@ -2,16 +2,6 @@ module Orb module Models - # @example - # ```ruby - # billable_metric => { - # id: String, - # description: String, - # item: Orb::Models::Item, - # metadata: -> { Orb::HashOf[String] === _1 }, - # name: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/coupon.rb b/lib/orb/models/coupon.rb index e5c1b78c..ae8c13c6 100644 --- a/lib/orb/models/coupon.rb +++ b/lib/orb/models/coupon.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # coupon => { - # id: String, - # archived_at: Time, - # discount: Orb::Models::Coupon::Discount, - # duration_in_months: Integer, - # max_redemptions: Integer, - # **_ - # } - # ``` class Coupon < Orb::BaseModel # @!attribute id # Also referred to as coupon_id in this documentation. @@ -84,17 +73,12 @@ class Coupon < Orb::BaseModel # case discount # in { # discount_type: "percentage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # percentage_discount: Float, # reason: String # } # # Orb::Models::PercentageDiscount ... - # in { - # discount_type: "amount", - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # reason: String - # } + # in {discount_type: "amount", amount_discount: String, applies_to_price_ids: ^(Orb::ArrayOf[String]), reason: String} # # Orb::Models::AmountDiscount ... # end # ``` diff --git a/lib/orb/models/coupon_create_params.rb b/lib/orb/models/coupon_create_params.rb index 0b2ea66f..d58359b8 100644 --- a/lib/orb/models/coupon_create_params.rb +++ b/lib/orb/models/coupon_create_params.rb @@ -71,13 +71,6 @@ class Discount < Orb::Union variant :amount, -> { Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount } - # @example - # ```ruby - # new_coupon_percentage_discount => { - # discount_type: :percentage, - # percentage_discount: Float - # } - # ``` class NewCouponPercentageDiscount < Orb::BaseModel # @!attribute discount_type # @@ -98,13 +91,6 @@ class NewCouponPercentageDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_coupon_amount_discount => { - # amount_discount: String, - # discount_type: :amount - # } - # ``` class NewCouponAmountDiscount < Orb::BaseModel # @!attribute amount_discount # diff --git a/lib/orb/models/credit_note.rb b/lib/orb/models/credit_note.rb index e8a2015f..ce641b99 100644 --- a/lib/orb/models/credit_note.rb +++ b/lib/orb/models/credit_note.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # credit_note => { - # id: String, - # created_at: Time, - # credit_note_number: String, - # credit_note_pdf: String, - # customer: Orb::Models::CreditNote::Customer, - # **_ - # } - # ``` class CreditNote < Orb::BaseModel # @!attribute id # The Orb id of this credit note. @@ -156,13 +145,6 @@ class CreditNote < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -183,17 +165,6 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # line_item => { - # id: String, - # amount: String, - # name: String, - # quantity: Float, - # subtotal: String, - # **_ - # } - # ``` class LineItem < Orb::BaseModel # @!attribute id # The Orb id of this resource. @@ -207,6 +178,12 @@ class LineItem < Orb::BaseModel # @return [String] required :amount, String + # @!attribute item_id + # The id of the item associated with this line item. + # + # @return [String] + required :item_id, String + # @!attribute name # The name of the corresponding invoice line item. # @@ -244,24 +221,17 @@ class LineItem < Orb::BaseModel # @!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:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil, **) = super + # def initialize(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil, **) = super # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tax_amount => { - # amount: String, - # tax_rate_description: String, - # tax_rate_percentage: String - # } - # ``` class TaxAmount < Orb::BaseModel # @!attribute amount # The amount of additional tax incurred by this tax rate. @@ -291,17 +261,6 @@ class TaxAmount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # discount => { - # id: String, - # amount_applied: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: Orb::Models::CreditNote::LineItem::Discount::DiscountType, - # percentage_discount: Float, - # **_ - # } - # ``` class Discount < Orb::BaseModel # @!attribute id # @@ -387,16 +346,6 @@ class DiscountType < Orb::Enum end end - # @example - # ```ruby - # maximum_amount_adjustment => { - # amount_applied: String, - # discount_type: Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType, - # percentage_discount: Float, - # applies_to_prices: -> { Orb::ArrayOf[Orb::Models::CreditNote::MaximumAmountAdjustment::AppliesToPrice] === _1 }, - # reason: String - # } - # ``` class MaximumAmountAdjustment < Orb::BaseModel # @!attribute amount_applied # @@ -458,13 +407,6 @@ class DiscountType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # applies_to_price => { - # id: String, - # name: String - # } - # ``` class AppliesToPrice < Orb::BaseModel # @!attribute id # @@ -538,16 +480,6 @@ class Type < Orb::Enum # def self.values; end end - # @example - # ```ruby - # discount => { - # amount_applied: String, - # discount_type: Orb::Models::CreditNote::Discount::DiscountType, - # percentage_discount: Float, - # applies_to_prices: -> { Orb::ArrayOf[Orb::Models::CreditNote::Discount::AppliesToPrice] === _1 }, - # reason: String - # } - # ``` class Discount < Orb::BaseModel # @!attribute amount_applied # @@ -607,13 +539,6 @@ class DiscountType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # applies_to_price => { - # id: String, - # name: String - # } - # ``` class AppliesToPrice < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/credit_note_create_params.rb b/lib/orb/models/credit_note_create_params.rb index f4855fc2..8f33d61b 100644 --- a/lib/orb/models/credit_note_create_params.rb +++ b/lib/orb/models/credit_note_create_params.rb @@ -34,13 +34,6 @@ class CreditNoteCreateParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # line_item => { - # amount: String, - # invoice_line_item_id: String - # } - # ``` class LineItem < Orb::BaseModel # @!attribute amount # The total amount in the invoice's currency to credit this line item. diff --git a/lib/orb/models/customer.rb b/lib/orb/models/customer.rb index 6f8f44c4..64130439 100644 --- a/lib/orb/models/customer.rb +++ b/lib/orb/models/customer.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # customer => { - # id: String, - # additional_emails: -> { Orb::ArrayOf[String] === _1 }, - # auto_collection: Orb::BooleanModel, - # balance: String, - # billing_address: Orb::Models::Customer::BillingAddress, - # **_ - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -317,16 +306,6 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billing_address => { - # city: String, - # country: String, - # line1: String, - # line2: String, - # postal_code: String - # } - # ``` class BillingAddress < Orb::BaseModel # @!attribute city # @@ -407,16 +386,6 @@ class PaymentProvider < Orb::Enum # def self.values; end end - # @example - # ```ruby - # shipping_address => { - # city: String, - # country: String, - # line1: String, - # line2: String, - # postal_code: String - # } - # ``` class ShippingAddress < Orb::BaseModel # @!attribute city # @@ -461,14 +430,6 @@ class ShippingAddress < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # tax_id => { - # country: Orb::Models::Customer::TaxID::Country, - # type: Orb::Models::Customer::TaxID::Type, - # value: String - # } - # ``` class TaxID < Orb::BaseModel # @!attribute country # @@ -808,13 +769,6 @@ class Type < Orb::Enum end end - # @example - # ```ruby - # accounting_sync_configuration => { - # accounting_providers: -> { Orb::ArrayOf[Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider] === _1 }, - # excluded: Orb::BooleanModel - # } - # ``` class AccountingSyncConfiguration < Orb::BaseModel # @!attribute accounting_providers # @@ -835,13 +789,6 @@ class AccountingSyncConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # accounting_provider => { - # external_provider_id: String, - # provider_type: Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType - # } - # ``` class AccountingProvider < Orb::BaseModel # @!attribute external_provider_id # @@ -887,12 +834,6 @@ class ProviderType < Orb::Enum end end - # @example - # ```ruby - # reporting_configuration => { - # exempt: Orb::BooleanModel - # } - # ``` class ReportingConfiguration < Orb::BaseModel # @!attribute exempt # diff --git a/lib/orb/models/customer_create_params.rb b/lib/orb/models/customer_create_params.rb index 01a334e8..9fa70ee3 100644 --- a/lib/orb/models/customer_create_params.rb +++ b/lib/orb/models/customer_create_params.rb @@ -272,13 +272,6 @@ class CustomerCreateParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # accounting_sync_configuration => { - # accounting_providers: -> { Orb::ArrayOf[Orb::Models::CustomerCreateParams::AccountingSyncConfiguration::AccountingProvider] === _1 }, - # excluded: Orb::BooleanModel - # } - # ``` class AccountingSyncConfiguration < Orb::BaseModel # @!attribute accounting_providers # @@ -300,13 +293,6 @@ class AccountingSyncConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # accounting_provider => { - # external_provider_id: String, - # provider_type: String - # } - # ``` class AccountingProvider < Orb::BaseModel # @!attribute external_provider_id # @@ -328,16 +314,6 @@ class AccountingProvider < Orb::BaseModel end end - # @example - # ```ruby - # billing_address => { - # city: String, - # country: String, - # line1: String, - # line2: String, - # postal_code: String - # } - # ``` class BillingAddress < Orb::BaseModel # @!attribute city # @@ -418,12 +394,6 @@ class PaymentProvider < Orb::Enum # def self.values; end end - # @example - # ```ruby - # reporting_configuration => { - # exempt: Orb::BooleanModel - # } - # ``` class ReportingConfiguration < Orb::BaseModel # @!attribute exempt # @@ -438,16 +408,6 @@ class ReportingConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # shipping_address => { - # city: String, - # country: String, - # line1: String, - # line2: String, - # postal_code: String - # } - # ``` class ShippingAddress < Orb::BaseModel # @!attribute city # @@ -520,14 +480,6 @@ class TaxConfiguration < Orb::Union variant :taxjar, -> { Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration } - # @example - # ```ruby - # new_avalara_tax_configuration => { - # tax_exempt: Orb::BooleanModel, - # tax_provider: :avalara, - # tax_exemption_code: String - # } - # ``` class NewAvalaraTaxConfiguration < Orb::BaseModel # @!attribute tax_exempt # @@ -554,13 +506,6 @@ class NewAvalaraTaxConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_tax_jar_configuration => { - # tax_exempt: Orb::BooleanModel, - # tax_provider: :taxjar - # } - # ``` class NewTaxJarConfiguration < Orb::BaseModel # @!attribute tax_exempt # @@ -582,14 +527,6 @@ class NewTaxJarConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # tax_id => { - # country: Orb::Models::CustomerCreateParams::TaxID::Country, - # type: Orb::Models::CustomerCreateParams::TaxID::Type, - # value: String - # } - # ``` class TaxID < Orb::BaseModel # @!attribute country # 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 b017bfe4..1a34666e 100644 --- a/lib/orb/models/customer_update_by_external_id_params.rb +++ b/lib/orb/models/customer_update_by_external_id_params.rb @@ -271,13 +271,6 @@ class CustomerUpdateByExternalIDParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # accounting_sync_configuration => { - # accounting_providers: -> { Orb::ArrayOf[Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider] === _1 }, - # excluded: Orb::BooleanModel - # } - # ``` class AccountingSyncConfiguration < Orb::BaseModel # @!attribute accounting_providers # @@ -299,13 +292,6 @@ class AccountingSyncConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # accounting_provider => { - # external_provider_id: String, - # provider_type: String - # } - # ``` class AccountingProvider < Orb::BaseModel # @!attribute external_provider_id # @@ -327,16 +313,6 @@ class AccountingProvider < Orb::BaseModel end end - # @example - # ```ruby - # billing_address => { - # city: String, - # country: String, - # line1: String, - # line2: String, - # postal_code: String - # } - # ``` class BillingAddress < Orb::BaseModel # @!attribute city # @@ -421,12 +397,6 @@ class PaymentProvider < Orb::Enum # def self.values; end end - # @example - # ```ruby - # reporting_configuration => { - # exempt: Orb::BooleanModel - # } - # ``` class ReportingConfiguration < Orb::BaseModel # @!attribute exempt # @@ -441,16 +411,6 @@ class ReportingConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # shipping_address => { - # city: String, - # country: String, - # line1: String, - # line2: String, - # postal_code: String - # } - # ``` class ShippingAddress < Orb::BaseModel # @!attribute city # @@ -525,14 +485,6 @@ class TaxConfiguration < Orb::Union variant :taxjar, -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration } - # @example - # ```ruby - # new_avalara_tax_configuration => { - # tax_exempt: Orb::BooleanModel, - # tax_provider: :avalara, - # tax_exemption_code: String - # } - # ``` class NewAvalaraTaxConfiguration < Orb::BaseModel # @!attribute tax_exempt # @@ -559,13 +511,6 @@ class NewAvalaraTaxConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_tax_jar_configuration => { - # tax_exempt: Orb::BooleanModel, - # tax_provider: :taxjar - # } - # ``` class NewTaxJarConfiguration < Orb::BaseModel # @!attribute tax_exempt # @@ -587,14 +532,6 @@ class NewTaxJarConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # tax_id => { - # country: Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country, - # type: Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type, - # value: String - # } - # ``` class TaxID < Orb::BaseModel # @!attribute country # diff --git a/lib/orb/models/customer_update_params.rb b/lib/orb/models/customer_update_params.rb index a86df8d3..964519d7 100644 --- a/lib/orb/models/customer_update_params.rb +++ b/lib/orb/models/customer_update_params.rb @@ -263,13 +263,6 @@ class CustomerUpdateParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # accounting_sync_configuration => { - # accounting_providers: -> { Orb::ArrayOf[Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider] === _1 }, - # excluded: Orb::BooleanModel - # } - # ``` class AccountingSyncConfiguration < Orb::BaseModel # @!attribute accounting_providers # @@ -291,13 +284,6 @@ class AccountingSyncConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # accounting_provider => { - # external_provider_id: String, - # provider_type: String - # } - # ``` class AccountingProvider < Orb::BaseModel # @!attribute external_provider_id # @@ -319,16 +305,6 @@ class AccountingProvider < Orb::BaseModel end end - # @example - # ```ruby - # billing_address => { - # city: String, - # country: String, - # line1: String, - # line2: String, - # postal_code: String - # } - # ``` class BillingAddress < Orb::BaseModel # @!attribute city # @@ -413,12 +389,6 @@ class PaymentProvider < Orb::Enum # def self.values; end end - # @example - # ```ruby - # reporting_configuration => { - # exempt: Orb::BooleanModel - # } - # ``` class ReportingConfiguration < Orb::BaseModel # @!attribute exempt # @@ -433,16 +403,6 @@ class ReportingConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # shipping_address => { - # city: String, - # country: String, - # line1: String, - # line2: String, - # postal_code: String - # } - # ``` class ShippingAddress < Orb::BaseModel # @!attribute city # @@ -515,14 +475,6 @@ class TaxConfiguration < Orb::Union variant :taxjar, -> { Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration } - # @example - # ```ruby - # new_avalara_tax_configuration => { - # tax_exempt: Orb::BooleanModel, - # tax_provider: :avalara, - # tax_exemption_code: String - # } - # ``` class NewAvalaraTaxConfiguration < Orb::BaseModel # @!attribute tax_exempt # @@ -549,13 +501,6 @@ class NewAvalaraTaxConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_tax_jar_configuration => { - # tax_exempt: Orb::BooleanModel, - # tax_provider: :taxjar - # } - # ``` class NewTaxJarConfiguration < Orb::BaseModel # @!attribute tax_exempt # @@ -577,14 +522,6 @@ class NewTaxJarConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # tax_id => { - # country: Orb::Models::CustomerUpdateParams::TaxID::Country, - # type: Orb::Models::CustomerUpdateParams::TaxID::Type, - # value: String - # } - # ``` class TaxID < Orb::BaseModel # @!attribute country # diff --git a/lib/orb/models/customers/balance_transaction_create_response.rb b/lib/orb/models/customers/balance_transaction_create_response.rb index 0f5e1b5b..feb8477d 100644 --- a/lib/orb/models/customers/balance_transaction_create_response.rb +++ b/lib/orb/models/customers/balance_transaction_create_response.rb @@ -3,17 +3,6 @@ module Orb module Models module Customers - # @example - # ```ruby - # balance_transaction_create_response => { - # id: String, - # action: Orb::Models::Customers::BalanceTransactionCreateResponse::Action, - # amount: String, - # created_at: Time, - # credit_note: Orb::Models::Customers::BalanceTransactionCreateResponse::CreditNote, - # **_ - # } - # ``` class BalanceTransactionCreateResponse < Orb::BaseModel # @!attribute id # A unique id for this transaction. @@ -143,12 +132,6 @@ class Action < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_note => { - # id: String - # } - # ``` class CreditNote < Orb::BaseModel # @!attribute id # The id of the Credit note @@ -164,12 +147,6 @@ class CreditNote < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoice => { - # id: String - # } - # ``` class Invoice < Orb::BaseModel # @!attribute id # The Invoice id diff --git a/lib/orb/models/customers/balance_transaction_list_response.rb b/lib/orb/models/customers/balance_transaction_list_response.rb index bce8754a..60af1576 100644 --- a/lib/orb/models/customers/balance_transaction_list_response.rb +++ b/lib/orb/models/customers/balance_transaction_list_response.rb @@ -3,17 +3,6 @@ module Orb module Models module Customers - # @example - # ```ruby - # balance_transaction_list_response => { - # id: String, - # action: Orb::Models::Customers::BalanceTransactionListResponse::Action, - # amount: String, - # created_at: Time, - # credit_note: Orb::Models::Customers::BalanceTransactionListResponse::CreditNote, - # **_ - # } - # ``` class BalanceTransactionListResponse < Orb::BaseModel # @!attribute id # A unique id for this transaction. @@ -143,12 +132,6 @@ class Action < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_note => { - # id: String - # } - # ``` class CreditNote < Orb::BaseModel # @!attribute id # The id of the Credit note @@ -164,12 +147,6 @@ class CreditNote < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoice => { - # id: String - # } - # ``` class Invoice < Orb::BaseModel # @!attribute id # The Invoice id 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 7e435f6f..57b041d4 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 @@ -3,12 +3,6 @@ module Orb module Models module Customers - # @example - # ```ruby - # cost_list_by_external_id_response => { - # data: -> { Orb::ArrayOf[Orb::Models::Customers::CostListByExternalIDResponse::Data] === _1 } - # } - # ``` class CostListByExternalIDResponse < Orb::BaseModel # @!attribute data # @@ -22,16 +16,6 @@ class CostListByExternalIDResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # data => { - # per_price_costs: -> { Orb::ArrayOf[Orb::Models::Customers::CostListByExternalIDResponse::Data::PerPriceCost] === _1 }, - # subtotal: String, - # timeframe_end: Time, - # timeframe_start: Time, - # total: String - # } - # ``` class Data < Orb::BaseModel # @!attribute per_price_costs # @@ -72,16 +56,6 @@ class Data < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # per_price_cost => { - # price: Orb::Models::Price, - # price_id: String, - # subtotal: String, - # total: String, - # quantity: Float - # } - # ``` class PerPriceCost < Orb::BaseModel # @!attribute price # The price object diff --git a/lib/orb/models/customers/cost_list_response.rb b/lib/orb/models/customers/cost_list_response.rb index a6816e6a..a21bca75 100644 --- a/lib/orb/models/customers/cost_list_response.rb +++ b/lib/orb/models/customers/cost_list_response.rb @@ -3,12 +3,6 @@ module Orb module Models module Customers - # @example - # ```ruby - # cost_list_response => { - # data: -> { Orb::ArrayOf[Orb::Models::Customers::CostListResponse::Data] === _1 } - # } - # ``` class CostListResponse < Orb::BaseModel # @!attribute data # @@ -22,16 +16,6 @@ class CostListResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # data => { - # per_price_costs: -> { Orb::ArrayOf[Orb::Models::Customers::CostListResponse::Data::PerPriceCost] === _1 }, - # subtotal: String, - # timeframe_end: Time, - # timeframe_start: Time, - # total: String - # } - # ``` class Data < Orb::BaseModel # @!attribute per_price_costs # @@ -72,16 +56,6 @@ class Data < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # per_price_cost => { - # price: Orb::Models::Price, - # price_id: String, - # subtotal: String, - # total: String, - # quantity: Float - # } - # ``` class PerPriceCost < Orb::BaseModel # @!attribute price # The price object 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 c733318e..5a181d22 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 @@ -3,17 +3,6 @@ module Orb module Models module Customers - # @example - # ```ruby - # credit_list_by_external_id_response => { - # id: String, - # balance: Float, - # effective_date: Time, - # expiry_date: Time, - # maximum_initial_balance: Float, - # **_ - # } - # ``` class CreditListByExternalIDResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/customers/credit_list_response.rb b/lib/orb/models/customers/credit_list_response.rb index bb0e5e48..3ad8dc03 100644 --- a/lib/orb/models/customers/credit_list_response.rb +++ b/lib/orb/models/customers/credit_list_response.rb @@ -3,17 +3,6 @@ module Orb module Models module Customers - # @example - # ```ruby - # credit_list_response => { - # id: String, - # balance: Float, - # effective_date: Time, - # expiry_date: Time, - # maximum_initial_balance: Float, - # **_ - # } - # ``` class CreditListResponse < Orb::BaseModel # @!attribute id # 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 a9a86711..93b1ee3b 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 @@ -154,15 +154,6 @@ class EntryType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # invoice_settings => { - # auto_collection: Orb::BooleanModel, - # net_terms: Integer, - # memo: String, - # require_successful_payment: Orb::BooleanModel - # } - # ``` class InvoiceSettings < Orb::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's 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 8aabc51c..66400693 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 @@ -72,17 +72,6 @@ class LedgerCreateEntryByExternalIDResponse < Orb::Union variant :amendment, -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry } - # @example - # ```ruby - # increment_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class IncrementLedgerEntry < Orb::BaseModel # @!attribute id # @@ -192,14 +181,6 @@ class IncrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -226,13 +207,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -277,17 +251,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # decrement_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class DecrementLedgerEntry < Orb::BaseModel # @!attribute id # @@ -418,14 +381,6 @@ class DecrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -452,13 +407,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -503,17 +451,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # expiration_change_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class ExpirationChangeLedgerEntry < Orb::BaseModel # @!attribute id # @@ -630,14 +567,6 @@ class ExpirationChangeLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -664,13 +593,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -715,17 +637,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # credit_block_expiry_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class CreditBlockExpiryLedgerEntry < Orb::BaseModel # @!attribute id # @@ -835,14 +746,6 @@ class CreditBlockExpiryLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -869,13 +772,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -920,17 +816,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # void_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class VoidLedgerEntry < Orb::BaseModel # @!attribute id # @@ -1054,14 +939,6 @@ class VoidLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1088,13 +965,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -1139,17 +1009,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # void_initiated_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class VoidInitiatedLedgerEntry < Orb::BaseModel # @!attribute id # @@ -1280,14 +1139,6 @@ class VoidInitiatedLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1314,13 +1165,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -1365,17 +1209,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # amendment_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class AmendmentLedgerEntry < Orb::BaseModel # @!attribute id # @@ -1485,14 +1318,6 @@ class AmendmentLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1519,13 +1344,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # 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 283188f0..3093090e 100644 --- a/lib/orb/models/customers/credits/ledger_create_entry_params.rb +++ b/lib/orb/models/customers/credits/ledger_create_entry_params.rb @@ -153,15 +153,6 @@ class EntryType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # invoice_settings => { - # auto_collection: Orb::BooleanModel, - # net_terms: Integer, - # memo: String, - # require_successful_payment: Orb::BooleanModel - # } - # ``` class InvoiceSettings < Orb::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's 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 a6bfa80e..a2746956 100644 --- a/lib/orb/models/customers/credits/ledger_create_entry_response.rb +++ b/lib/orb/models/customers/credits/ledger_create_entry_response.rb @@ -71,17 +71,6 @@ class LedgerCreateEntryResponse < Orb::Union variant :amendment, -> { Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry } - # @example - # ```ruby - # increment_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class IncrementLedgerEntry < Orb::BaseModel # @!attribute id # @@ -191,14 +180,6 @@ class IncrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -225,13 +206,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -276,17 +250,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # decrement_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class DecrementLedgerEntry < Orb::BaseModel # @!attribute id # @@ -417,14 +380,6 @@ class DecrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -451,13 +406,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -502,17 +450,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # expiration_change_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class ExpirationChangeLedgerEntry < Orb::BaseModel # @!attribute id # @@ -629,14 +566,6 @@ class ExpirationChangeLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -663,13 +592,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -714,17 +636,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # credit_block_expiry_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class CreditBlockExpiryLedgerEntry < Orb::BaseModel # @!attribute id # @@ -834,14 +745,6 @@ class CreditBlockExpiryLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -868,13 +771,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -919,17 +815,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # void_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class VoidLedgerEntry < Orb::BaseModel # @!attribute id # @@ -1053,14 +938,6 @@ class VoidLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1087,13 +964,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -1138,17 +1008,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # void_initiated_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class VoidInitiatedLedgerEntry < Orb::BaseModel # @!attribute id # @@ -1279,14 +1138,6 @@ class VoidInitiatedLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1313,13 +1164,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -1364,17 +1208,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # amendment_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class AmendmentLedgerEntry < Orb::BaseModel # @!attribute id # @@ -1484,14 +1317,6 @@ class AmendmentLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1518,13 +1343,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # 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 b28efb2d..34123314 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 @@ -71,17 +71,6 @@ class LedgerListByExternalIDResponse < Orb::Union variant :amendment, -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry } - # @example - # ```ruby - # increment_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class IncrementLedgerEntry < Orb::BaseModel # @!attribute id # @@ -191,14 +180,6 @@ class IncrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -225,13 +206,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -276,17 +250,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # decrement_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class DecrementLedgerEntry < Orb::BaseModel # @!attribute id # @@ -417,14 +380,6 @@ class DecrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -451,13 +406,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -502,17 +450,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # expiration_change_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class ExpirationChangeLedgerEntry < Orb::BaseModel # @!attribute id # @@ -629,14 +566,6 @@ class ExpirationChangeLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -663,13 +592,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -714,17 +636,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # credit_block_expiry_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class CreditBlockExpiryLedgerEntry < Orb::BaseModel # @!attribute id # @@ -834,14 +745,6 @@ class CreditBlockExpiryLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -868,13 +771,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -919,17 +815,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # void_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class VoidLedgerEntry < Orb::BaseModel # @!attribute id # @@ -1053,14 +938,6 @@ class VoidLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1087,13 +964,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -1138,17 +1008,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # void_initiated_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class VoidInitiatedLedgerEntry < Orb::BaseModel # @!attribute id # @@ -1279,14 +1138,6 @@ class VoidInitiatedLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1313,13 +1164,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -1364,17 +1208,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # amendment_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class AmendmentLedgerEntry < Orb::BaseModel # @!attribute id # @@ -1484,14 +1317,6 @@ class AmendmentLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1518,13 +1343,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/customers/credits/ledger_list_response.rb b/lib/orb/models/customers/credits/ledger_list_response.rb index f799fa7c..345e2f1f 100644 --- a/lib/orb/models/customers/credits/ledger_list_response.rb +++ b/lib/orb/models/customers/credits/ledger_list_response.rb @@ -68,17 +68,6 @@ class LedgerListResponse < Orb::Union variant :amendment, -> { Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry } - # @example - # ```ruby - # increment_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class IncrementLedgerEntry < Orb::BaseModel # @!attribute id # @@ -188,14 +177,6 @@ class IncrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -222,13 +203,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -273,17 +247,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # decrement_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class DecrementLedgerEntry < Orb::BaseModel # @!attribute id # @@ -414,14 +377,6 @@ class DecrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -448,13 +403,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -499,17 +447,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # expiration_change_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class ExpirationChangeLedgerEntry < Orb::BaseModel # @!attribute id # @@ -626,14 +563,6 @@ class ExpirationChangeLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -660,13 +589,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -711,17 +633,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # credit_block_expiry_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class CreditBlockExpiryLedgerEntry < Orb::BaseModel # @!attribute id # @@ -831,14 +742,6 @@ class CreditBlockExpiryLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -865,13 +768,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -916,17 +812,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # void_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class VoidLedgerEntry < Orb::BaseModel # @!attribute id # @@ -1049,14 +934,6 @@ class VoidLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1083,13 +960,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -1134,17 +1004,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # void_initiated_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class VoidInitiatedLedgerEntry < Orb::BaseModel # @!attribute id # @@ -1275,14 +1134,6 @@ class VoidInitiatedLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1309,13 +1160,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -1360,17 +1204,6 @@ class EntryStatus < Orb::Enum end end - # @example - # ```ruby - # amendment_ledger_entry => { - # id: String, - # amount: Float, - # created_at: Time, - # credit_block: Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::CreditBlock, - # currency: String, - # **_ - # } - # ``` class AmendmentLedgerEntry < Orb::BaseModel # @!attribute id # @@ -1480,14 +1313,6 @@ class AmendmentLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # credit_block => { - # id: String, - # expiry_date: Time, - # per_unit_cost_basis: String - # } - # ``` class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1514,13 +1339,6 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # 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 332badd0..b04bd321 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 @@ -83,15 +83,6 @@ class TopUpCreateByExternalIDParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # invoice_settings => { - # auto_collection: Orb::BooleanModel, - # net_terms: Integer, - # memo: String, - # require_successful_payment: Orb::BooleanModel - # } - # ``` class InvoiceSettings < Orb::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's 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 4d5468a8..4b7bd4c9 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 @@ -4,17 +4,6 @@ module Orb module Models module Customers module Credits - # @example - # ```ruby - # top_up_create_by_external_id_response => { - # id: String, - # amount: String, - # currency: String, - # invoice_settings: Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings, - # per_unit_cost_basis: String, - # **_ - # } - # ``` class TopUpCreateByExternalIDResponse < Orb::BaseModel # @!attribute id # @@ -95,15 +84,6 @@ class TopUpCreateByExternalIDResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # invoice_settings => { - # auto_collection: Orb::BooleanModel, - # net_terms: Integer, - # memo: String, - # require_successful_payment: Orb::BooleanModel - # } - # ``` class InvoiceSettings < Orb::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's 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 4ed9d9ed..7b9db5b5 100644 --- a/lib/orb/models/customers/credits/top_up_create_params.rb +++ b/lib/orb/models/customers/credits/top_up_create_params.rb @@ -82,15 +82,6 @@ class TopUpCreateParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # invoice_settings => { - # auto_collection: Orb::BooleanModel, - # net_terms: Integer, - # memo: String, - # require_successful_payment: Orb::BooleanModel - # } - # ``` class InvoiceSettings < Orb::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's 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 43b8b8d6..7c9a61af 100644 --- a/lib/orb/models/customers/credits/top_up_create_response.rb +++ b/lib/orb/models/customers/credits/top_up_create_response.rb @@ -4,17 +4,6 @@ module Orb module Models module Customers module Credits - # @example - # ```ruby - # top_up_create_response => { - # id: String, - # amount: String, - # currency: String, - # invoice_settings: Orb::Models::Customers::Credits::TopUpCreateResponse::InvoiceSettings, - # per_unit_cost_basis: String, - # **_ - # } - # ``` class TopUpCreateResponse < Orb::BaseModel # @!attribute id # @@ -94,15 +83,6 @@ class TopUpCreateResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # invoice_settings => { - # auto_collection: Orb::BooleanModel, - # net_terms: Integer, - # memo: String, - # require_successful_payment: Orb::BooleanModel - # } - # ``` class InvoiceSettings < Orb::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's 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 c9db9605..abb7207f 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 @@ -4,17 +4,6 @@ module Orb module Models module Customers module Credits - # @example - # ```ruby - # top_up_list_by_external_id_response => { - # id: String, - # amount: String, - # currency: String, - # invoice_settings: Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::InvoiceSettings, - # per_unit_cost_basis: String, - # **_ - # } - # ``` class TopUpListByExternalIDResponse < Orb::BaseModel # @!attribute id # @@ -95,15 +84,6 @@ class TopUpListByExternalIDResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # invoice_settings => { - # auto_collection: Orb::BooleanModel, - # net_terms: Integer, - # memo: String, - # require_successful_payment: Orb::BooleanModel - # } - # ``` class InvoiceSettings < Orb::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's 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 3a89cc58..8043075b 100644 --- a/lib/orb/models/customers/credits/top_up_list_response.rb +++ b/lib/orb/models/customers/credits/top_up_list_response.rb @@ -4,17 +4,6 @@ module Orb module Models module Customers module Credits - # @example - # ```ruby - # top_up_list_response => { - # id: String, - # amount: String, - # currency: String, - # invoice_settings: Orb::Models::Customers::Credits::TopUpListResponse::InvoiceSettings, - # per_unit_cost_basis: String, - # **_ - # } - # ``` class TopUpListResponse < Orb::BaseModel # @!attribute id # @@ -94,15 +83,6 @@ class TopUpListResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # invoice_settings => { - # auto_collection: Orb::BooleanModel, - # net_terms: Integer, - # memo: String, - # require_successful_payment: Orb::BooleanModel - # } - # ``` class InvoiceSettings < Orb::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's diff --git a/lib/orb/models/dimensional_price_group.rb b/lib/orb/models/dimensional_price_group.rb index e2c44c3d..d7c1066e 100644 --- a/lib/orb/models/dimensional_price_group.rb +++ b/lib/orb/models/dimensional_price_group.rb @@ -2,16 +2,6 @@ module Orb module Models - # @example - # ```ruby - # dimensional_price_group => { - # id: String, - # billable_metric_id: String, - # dimensions: -> { Orb::ArrayOf[String] === _1 }, - # external_dimensional_price_group_id: String, - # metadata: -> { Orb::HashOf[String] === _1 } - # } - # ``` class DimensionalPriceGroup < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/dimensional_price_groups.rb b/lib/orb/models/dimensional_price_groups.rb index f3ca638e..d58492de 100644 --- a/lib/orb/models/dimensional_price_groups.rb +++ b/lib/orb/models/dimensional_price_groups.rb @@ -2,13 +2,6 @@ module Orb module Models - # @example - # ```ruby - # dimensional_price_groups_api => { - # data: -> { Orb::ArrayOf[Orb::Models::DimensionalPriceGroup] === _1 }, - # pagination_metadata: Orb::Models::PaginationMetadata - # } - # ``` class DimensionalPriceGroupsAPI < Orb::BaseModel # @!attribute data # diff --git a/lib/orb/models/discount.rb b/lib/orb/models/discount.rb index eea68788..85004455 100644 --- a/lib/orb/models/discount.rb +++ b/lib/orb/models/discount.rb @@ -9,31 +9,21 @@ module Models # case discount # in { # discount_type: "percentage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # percentage_discount: Float, # reason: String # } # # Orb::Models::PercentageDiscount ... # in { # discount_type: "trial", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # reason: String, # trial_amount_discount: String # } # # Orb::Models::TrialDiscount ... - # in { - # discount_type: "usage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # usage_discount: Float, - # reason: String - # } + # in {discount_type: "usage", applies_to_price_ids: ^(Orb::ArrayOf[String]), usage_discount: Float, reason: String} # # Orb::Models::Discount::UsageDiscount ... - # in { - # discount_type: "amount", - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # reason: String - # } + # in {discount_type: "amount", amount_discount: String, applies_to_price_ids: ^(Orb::ArrayOf[String]), reason: String} # # Orb::Models::AmountDiscount ... # end # ``` @@ -62,15 +52,6 @@ class Discount < Orb::Union variant :amount, -> { Orb::Models::AmountDiscount } - # @example - # ```ruby - # usage_discount => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :usage, - # usage_discount: Float, - # reason: String - # } - # ``` class UsageDiscount < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this discount applies to. For plan/plan phase discounts, diff --git a/lib/orb/models/evaluate_price_group.rb b/lib/orb/models/evaluate_price_group.rb index 88f95b7a..e14da621 100644 --- a/lib/orb/models/evaluate_price_group.rb +++ b/lib/orb/models/evaluate_price_group.rb @@ -2,14 +2,6 @@ module Orb module Models - # @example - # ```ruby - # evaluate_price_group => { - # amount: String, - # grouping_values: -> { Orb::ArrayOf[union: Orb::Models::EvaluatePriceGroup::GroupingValue] === _1 }, - # quantity: Float - # } - # ``` class EvaluatePriceGroup < Orb::BaseModel # @!attribute amount # The price's output for the group diff --git a/lib/orb/models/event_deprecate_response.rb b/lib/orb/models/event_deprecate_response.rb index c5e1b117..b07dbc50 100644 --- a/lib/orb/models/event_deprecate_response.rb +++ b/lib/orb/models/event_deprecate_response.rb @@ -2,12 +2,6 @@ module Orb module Models - # @example - # ```ruby - # event_deprecate_response => { - # deprecated: String - # } - # ``` class EventDeprecateResponse < Orb::BaseModel # @!attribute deprecated # event_id of the deprecated event, if successfully updated diff --git a/lib/orb/models/event_ingest_params.rb b/lib/orb/models/event_ingest_params.rb index e508a6f9..27178752 100644 --- a/lib/orb/models/event_ingest_params.rb +++ b/lib/orb/models/event_ingest_params.rb @@ -39,16 +39,6 @@ class EventIngestParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # event => { - # event_name: String, - # idempotency_key: String, - # properties: Orb::Unknown, - # timestamp: Time, - # customer_id: String - # } - # ``` class Event < Orb::BaseModel # @!attribute event_name # A name to meaningfully identify the action or event type. diff --git a/lib/orb/models/event_ingest_response.rb b/lib/orb/models/event_ingest_response.rb index 42ed412f..ddfb6c81 100644 --- a/lib/orb/models/event_ingest_response.rb +++ b/lib/orb/models/event_ingest_response.rb @@ -2,13 +2,6 @@ module Orb module Models - # @example - # ```ruby - # event_ingest_response => { - # validation_failed: -> { Orb::ArrayOf[Orb::Models::EventIngestResponse::ValidationFailed] === _1 }, - # debug: Orb::Models::EventIngestResponse::Debug - # } - # ``` class EventIngestResponse < Orb::BaseModel # @!attribute validation_failed # Contains all failing validation events. In the case of a 200, this array will @@ -32,13 +25,6 @@ class EventIngestResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # validation_failed => { - # idempotency_key: String, - # validation_errors: -> { Orb::ArrayOf[String] === _1 } - # } - # ``` class ValidationFailed < Orb::BaseModel # @!attribute idempotency_key # The passed idempotency_key corresponding to the validation_errors @@ -62,13 +48,6 @@ class ValidationFailed < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # debug => { - # duplicate: -> { Orb::ArrayOf[String] === _1 }, - # ingested: -> { Orb::ArrayOf[String] === _1 } - # } - # ``` class Debug < Orb::BaseModel # @!attribute duplicate # diff --git a/lib/orb/models/event_search_response.rb b/lib/orb/models/event_search_response.rb index 6a5d1e4e..406d95fc 100644 --- a/lib/orb/models/event_search_response.rb +++ b/lib/orb/models/event_search_response.rb @@ -2,12 +2,6 @@ module Orb module Models - # @example - # ```ruby - # event_search_response => { - # data: -> { Orb::ArrayOf[Orb::Models::EventSearchResponse::Data] === _1 } - # } - # ``` class EventSearchResponse < Orb::BaseModel # @!attribute data # @@ -21,17 +15,6 @@ class EventSearchResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # data => { - # id: String, - # customer_id: String, - # deprecated: Orb::BooleanModel, - # event_name: String, - # external_customer_id: String, - # **_ - # } - # ``` class Data < Orb::BaseModel # @!attribute id # A unique value, generated by the client, that is used to de-duplicate events. diff --git a/lib/orb/models/event_update_response.rb b/lib/orb/models/event_update_response.rb index ab3056e1..80989444 100644 --- a/lib/orb/models/event_update_response.rb +++ b/lib/orb/models/event_update_response.rb @@ -2,12 +2,6 @@ module Orb module Models - # @example - # ```ruby - # event_update_response => { - # amended: String - # } - # ``` class EventUpdateResponse < Orb::BaseModel # @!attribute amended # event_id of the amended event, if successfully ingested diff --git a/lib/orb/models/events/backfill_close_response.rb b/lib/orb/models/events/backfill_close_response.rb index dcc01091..06106b9f 100644 --- a/lib/orb/models/events/backfill_close_response.rb +++ b/lib/orb/models/events/backfill_close_response.rb @@ -3,17 +3,6 @@ module Orb module Models module Events - # @example - # ```ruby - # backfill_close_response => { - # id: String, - # close_time: Time, - # created_at: Time, - # customer_id: String, - # events_ingested: Integer, - # **_ - # } - # ``` class BackfillCloseResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/events/backfill_create_response.rb b/lib/orb/models/events/backfill_create_response.rb index 52716fa4..2a1525bf 100644 --- a/lib/orb/models/events/backfill_create_response.rb +++ b/lib/orb/models/events/backfill_create_response.rb @@ -3,17 +3,6 @@ module Orb module Models module Events - # @example - # ```ruby - # backfill_create_response => { - # id: String, - # close_time: Time, - # created_at: Time, - # customer_id: String, - # events_ingested: Integer, - # **_ - # } - # ``` class BackfillCreateResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/events/backfill_fetch_response.rb b/lib/orb/models/events/backfill_fetch_response.rb index e0f27cf1..c8ba856b 100644 --- a/lib/orb/models/events/backfill_fetch_response.rb +++ b/lib/orb/models/events/backfill_fetch_response.rb @@ -3,17 +3,6 @@ module Orb module Models module Events - # @example - # ```ruby - # backfill_fetch_response => { - # id: String, - # close_time: Time, - # created_at: Time, - # customer_id: String, - # events_ingested: Integer, - # **_ - # } - # ``` class BackfillFetchResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/events/backfill_list_response.rb b/lib/orb/models/events/backfill_list_response.rb index 1d9794e0..56eb74e2 100644 --- a/lib/orb/models/events/backfill_list_response.rb +++ b/lib/orb/models/events/backfill_list_response.rb @@ -3,17 +3,6 @@ module Orb module Models module Events - # @example - # ```ruby - # backfill_list_response => { - # id: String, - # close_time: Time, - # created_at: Time, - # customer_id: String, - # events_ingested: Integer, - # **_ - # } - # ``` class BackfillListResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/events/backfill_revert_response.rb b/lib/orb/models/events/backfill_revert_response.rb index 1efaf526..dd2c7cb5 100644 --- a/lib/orb/models/events/backfill_revert_response.rb +++ b/lib/orb/models/events/backfill_revert_response.rb @@ -3,17 +3,6 @@ module Orb module Models module Events - # @example - # ```ruby - # backfill_revert_response => { - # id: String, - # close_time: Time, - # created_at: Time, - # customer_id: String, - # events_ingested: Integer, - # **_ - # } - # ``` class BackfillRevertResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/events/event_volumes.rb b/lib/orb/models/events/event_volumes.rb index a65cf9b1..0f3ff561 100644 --- a/lib/orb/models/events/event_volumes.rb +++ b/lib/orb/models/events/event_volumes.rb @@ -3,12 +3,6 @@ module Orb module Models module Events - # @example - # ```ruby - # event_volumes => { - # data: -> { Orb::ArrayOf[Orb::Models::Events::EventVolumes::Data] === _1 } - # } - # ``` class EventVolumes < Orb::BaseModel # @!attribute data # @@ -22,14 +16,6 @@ class EventVolumes < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # data => { - # count: Integer, - # timeframe_end: Time, - # timeframe_start: Time - # } - # ``` class Data < Orb::BaseModel # @!attribute count # The number of events ingested with a timestamp between the timeframe diff --git a/lib/orb/models/invoice.rb b/lib/orb/models/invoice.rb index 52ce0591..1a11a48a 100644 --- a/lib/orb/models/invoice.rb +++ b/lib/orb/models/invoice.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # invoice => { - # id: String, - # amount_due: String, - # auto_collection: Orb::Models::Invoice::AutoCollection, - # billing_address: Orb::Models::Invoice::BillingAddress, - # created_at: Time, - # **_ - # } - # ``` class Invoice < Orb::BaseModel # @!attribute id # @@ -472,15 +461,6 @@ class Invoice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # auto_collection => { - # enabled: Orb::BooleanModel, - # next_attempt_at: Time, - # num_attempts: Integer, - # previously_attempted_at: Time - # } - # ``` class AutoCollection < Orb::BaseModel # @!attribute enabled # True only if auto-collection is enabled for this invoice. @@ -524,16 +504,6 @@ class AutoCollection < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_address => { - # city: String, - # country: String, - # line1: String, - # line2: String, - # postal_code: String - # } - # ``` class BillingAddress < Orb::BaseModel # @!attribute city # @@ -578,17 +548,6 @@ class BillingAddress < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # credit_note => { - # id: String, - # credit_note_number: String, - # memo: String, - # reason: String, - # total: String, - # **_ - # } - # ``` class CreditNote < Orb::BaseModel # @!attribute id # @@ -642,13 +601,6 @@ class CreditNote < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -669,17 +621,6 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer_balance_transaction => { - # id: String, - # action: Orb::Models::Invoice::CustomerBalanceTransaction::Action, - # amount: String, - # created_at: Time, - # credit_note: Orb::Models::Invoice::CustomerBalanceTransaction::CreditNote, - # **_ - # } - # ``` class CustomerBalanceTransaction < Orb::BaseModel # @!attribute id # A unique id for this transaction. @@ -807,12 +748,6 @@ class Action < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_note => { - # id: String - # } - # ``` class CreditNote < Orb::BaseModel # @!attribute id # The id of the Credit note @@ -828,12 +763,6 @@ class CreditNote < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoice => { - # id: String - # } - # ``` class Invoice < Orb::BaseModel # @!attribute id # The Invoice id @@ -873,14 +802,6 @@ class Type < Orb::Enum end end - # @example - # ```ruby - # customer_tax_id => { - # country: Orb::Models::Invoice::CustomerTaxID::Country, - # type: Orb::Models::Invoice::CustomerTaxID::Type, - # value: String - # } - # ``` class CustomerTaxID < Orb::BaseModel # @!attribute country # @@ -1246,17 +1167,6 @@ class InvoiceSource < Orb::Enum # def self.values; end end - # @example - # ```ruby - # line_item => { - # id: String, - # adjusted_subtotal: String, - # adjustments: -> { Orb::ArrayOf[union: Orb::Models::Invoice::LineItem::Adjustment] === _1 }, - # amount: String, - # credits_applied: String, - # **_ - # } - # ``` class LineItem < Orb::BaseModel # @!attribute id # A unique ID for this line item. @@ -1447,12 +1357,7 @@ class LineItem < Orb::BaseModel # @example # ```ruby # case adjustment - # in { - # adjustment_type: "usage_discount", - # id: String, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } - # } + # in {adjustment_type: "usage_discount", id: String, amount: String, applies_to_price_ids: ^(Orb::ArrayOf[String])} # # Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment ... # in {adjustment_type: "amount_discount", id: String, amount: String, amount_discount: String} # # Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment ... @@ -1460,12 +1365,12 @@ class LineItem < Orb::BaseModel # adjustment_type: "percentage_discount", # id: String, # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment ... - # in {adjustment_type: "minimum", id: String, amount: String, applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }} + # in {adjustment_type: "minimum", id: String, amount: String, applies_to_price_ids: ^(Orb::ArrayOf[String])} # # Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment ... - # in {adjustment_type: "maximum", id: String, amount: String, applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }} + # in {adjustment_type: "maximum", id: String, amount: String, applies_to_price_ids: ^(Orb::ArrayOf[String])} # # Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment ... # end # ``` @@ -1501,17 +1406,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment } - # @example - # ```ruby - # monetary_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class MonetaryUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -1580,17 +1474,6 @@ class MonetaryUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # monetary_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount: String, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # **_ - # } - # ``` class MonetaryAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -1659,17 +1542,6 @@ class MonetaryAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # monetary_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class MonetaryPercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -1738,17 +1610,6 @@ class MonetaryPercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # monetary_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class MonetaryMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -1825,17 +1686,6 @@ class MonetaryMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # monetary_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class MonetaryMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -1905,13 +1755,6 @@ class MonetaryMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -1937,13 +1780,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -2018,16 +1854,6 @@ class SubLineItem < Orb::Union variant :"'null'", -> { Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem } - # @example - # ```ruby - # matrix_sub_line_item => { - # amount: String, - # grouping: Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem::Grouping, - # matrix_config: Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig, - # name: String, - # quantity: Float - # } - # ``` class MatrixSubLineItem < Orb::BaseModel # @!attribute amount # The total amount for this sub line item. @@ -2075,13 +1901,6 @@ class MatrixSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # grouping => { - # key: String, - # value: String - # } - # ``` class Grouping < Orb::BaseModel # @!attribute key # @@ -2103,12 +1922,6 @@ class Grouping < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # matrix_config => { - # dimension_values: -> { Orb::ArrayOf[String, nil?: true] === _1 } - # } - # ``` class MatrixConfig < Orb::BaseModel # @!attribute dimension_values # The ordered dimension values for this line item. @@ -2125,16 +1938,6 @@ class MatrixConfig < Orb::BaseModel end end - # @example - # ```ruby - # tier_sub_line_item => { - # amount: String, - # grouping: Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem::Grouping, - # name: String, - # quantity: Float, - # tier_config: Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem::TierConfig - # } - # ``` class TierSubLineItem < Orb::BaseModel # @!attribute amount # The total amount for this sub line item. @@ -2181,13 +1984,6 @@ class TierSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # grouping => { - # key: String, - # value: String - # } - # ``` class Grouping < Orb::BaseModel # @!attribute key # @@ -2209,14 +2005,6 @@ class Grouping < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # tier_config => { - # first_unit: Float, - # last_unit: Float, - # unit_amount: String - # } - # ``` class TierConfig < Orb::BaseModel # @!attribute first_unit # @@ -2244,16 +2032,6 @@ class TierConfig < Orb::BaseModel end end - # @example - # ```ruby - # other_sub_line_item => { - # amount: String, - # grouping: Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem::Grouping, - # name: String, - # quantity: Float, - # type: :"'null'" - # } - # ``` class OtherSubLineItem < Orb::BaseModel # @!attribute amount # The total amount for this sub line item. @@ -2294,13 +2072,6 @@ class OtherSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # grouping => { - # key: String, - # value: String - # } - # ``` class Grouping < Orb::BaseModel # @!attribute key # @@ -2324,14 +2095,6 @@ class Grouping < Orb::BaseModel end end - # @example - # ```ruby - # tax_amount => { - # amount: String, - # tax_rate_description: String, - # tax_rate_percentage: String - # } - # ``` class TaxAmount < Orb::BaseModel # @!attribute amount # The amount of additional tax incurred by this tax rate. @@ -2362,13 +2125,6 @@ class TaxAmount < Orb::BaseModel end end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -2392,13 +2148,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -2422,16 +2171,6 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # payment_attempt => { - # id: String, - # amount: String, - # created_at: Time, - # payment_provider: Orb::Models::Invoice::PaymentAttempt::PaymentProvider, - # payment_provider_id: String - # } - # ``` class PaymentAttempt < Orb::BaseModel # @!attribute id # The ID of the payment attempt. @@ -2504,16 +2243,6 @@ class PaymentProvider < Orb::Enum end end - # @example - # ```ruby - # shipping_address => { - # city: String, - # country: String, - # line1: String, - # line2: String, - # postal_code: String - # } - # ``` class ShippingAddress < Orb::BaseModel # @!attribute city # @@ -2590,12 +2319,6 @@ class Status < Orb::Enum # def self.values; end end - # @example - # ```ruby - # subscription => { - # id: String - # } - # ``` class Subscription < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/invoice_create_params.rb b/lib/orb/models/invoice_create_params.rb index ef4962c8..73894b77 100644 --- a/lib/orb/models/invoice_create_params.rb +++ b/lib/orb/models/invoice_create_params.rb @@ -112,17 +112,6 @@ class InvoiceCreateParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # line_item => { - # end_date: Date, - # item_id: String, - # model_type: Orb::Models::InvoiceCreateParams::LineItem::ModelType, - # name: String, - # quantity: Float, - # **_ - # } - # ``` class LineItem < Orb::BaseModel # @!attribute end_date # A date string to specify the line item's end date in the customer's timezone. @@ -196,12 +185,6 @@ class ModelType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # unit_config => { - # unit_amount: String - # } - # ``` class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage diff --git a/lib/orb/models/invoice_fetch_upcoming_response.rb b/lib/orb/models/invoice_fetch_upcoming_response.rb index 29304c16..b5f07d12 100644 --- a/lib/orb/models/invoice_fetch_upcoming_response.rb +++ b/lib/orb/models/invoice_fetch_upcoming_response.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # invoice_fetch_upcoming_response => { - # id: String, - # amount_due: String, - # auto_collection: Orb::Models::InvoiceFetchUpcomingResponse::AutoCollection, - # billing_address: Orb::Models::InvoiceFetchUpcomingResponse::BillingAddress, - # created_at: Time, - # **_ - # } - # ``` class InvoiceFetchUpcomingResponse < Orb::BaseModel # @!attribute id # @@ -466,15 +455,6 @@ class InvoiceFetchUpcomingResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # auto_collection => { - # enabled: Orb::BooleanModel, - # next_attempt_at: Time, - # num_attempts: Integer, - # previously_attempted_at: Time - # } - # ``` class AutoCollection < Orb::BaseModel # @!attribute enabled # True only if auto-collection is enabled for this invoice. @@ -518,16 +498,6 @@ class AutoCollection < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_address => { - # city: String, - # country: String, - # line1: String, - # line2: String, - # postal_code: String - # } - # ``` class BillingAddress < Orb::BaseModel # @!attribute city # @@ -572,17 +542,6 @@ class BillingAddress < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # credit_note => { - # id: String, - # credit_note_number: String, - # memo: String, - # reason: String, - # total: String, - # **_ - # } - # ``` class CreditNote < Orb::BaseModel # @!attribute id # @@ -636,13 +595,6 @@ class CreditNote < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer => { - # id: String, - # external_customer_id: String - # } - # ``` class Customer < Orb::BaseModel # @!attribute id # @@ -663,17 +615,6 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # customer_balance_transaction => { - # id: String, - # action: Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action, - # amount: String, - # created_at: Time, - # credit_note: Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::CreditNote, - # **_ - # } - # ``` class CustomerBalanceTransaction < Orb::BaseModel # @!attribute id # A unique id for this transaction. @@ -806,12 +747,6 @@ class Action < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_note => { - # id: String - # } - # ``` class CreditNote < Orb::BaseModel # @!attribute id # The id of the Credit note @@ -827,12 +762,6 @@ class CreditNote < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoice => { - # id: String - # } - # ``` class Invoice < Orb::BaseModel # @!attribute id # The Invoice id @@ -872,14 +801,6 @@ class Type < Orb::Enum end end - # @example - # ```ruby - # customer_tax_id => { - # country: Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country, - # type: Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type, - # value: String - # } - # ``` class CustomerTaxID < Orb::BaseModel # @!attribute country # @@ -1245,17 +1166,6 @@ class InvoiceSource < Orb::Enum # def self.values; end end - # @example - # ```ruby - # line_item => { - # id: String, - # adjusted_subtotal: String, - # adjustments: -> { Orb::ArrayOf[union: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment] === _1 }, - # amount: String, - # credits_applied: String, - # **_ - # } - # ``` class LineItem < Orb::BaseModel # @!attribute id # A unique ID for this line item. @@ -1448,12 +1358,7 @@ class LineItem < Orb::BaseModel # @example # ```ruby # case adjustment - # in { - # adjustment_type: "usage_discount", - # id: String, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } - # } + # in {adjustment_type: "usage_discount", id: String, amount: String, applies_to_price_ids: ^(Orb::ArrayOf[String])} # # Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment ... # in {adjustment_type: "amount_discount", id: String, amount: String, amount_discount: String} # # Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment ... @@ -1461,12 +1366,12 @@ class LineItem < Orb::BaseModel # adjustment_type: "percentage_discount", # id: String, # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment ... - # in {adjustment_type: "minimum", id: String, amount: String, applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }} + # in {adjustment_type: "minimum", id: String, amount: String, applies_to_price_ids: ^(Orb::ArrayOf[String])} # # Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment ... - # in {adjustment_type: "maximum", id: String, amount: String, applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }} + # in {adjustment_type: "maximum", id: String, amount: String, applies_to_price_ids: ^(Orb::ArrayOf[String])} # # Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment ... # end # ``` @@ -1504,17 +1409,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment } - # @example - # ```ruby - # monetary_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class MonetaryUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -1583,17 +1477,6 @@ class MonetaryUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # monetary_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount: String, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # **_ - # } - # ``` class MonetaryAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -1662,17 +1545,6 @@ class MonetaryAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # monetary_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class MonetaryPercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -1741,17 +1613,6 @@ class MonetaryPercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # monetary_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class MonetaryMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -1828,17 +1689,6 @@ class MonetaryMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # monetary_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class MonetaryMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -1908,13 +1758,6 @@ class MonetaryMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -1940,13 +1783,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -2023,16 +1859,6 @@ class SubLineItem < Orb::Union variant :"'null'", -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem } - # @example - # ```ruby - # matrix_sub_line_item => { - # amount: String, - # grouping: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::Grouping, - # matrix_config: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig, - # name: String, - # quantity: Float - # } - # ``` class MatrixSubLineItem < Orb::BaseModel # @!attribute amount # The total amount for this sub line item. @@ -2080,13 +1906,6 @@ class MatrixSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # grouping => { - # key: String, - # value: String - # } - # ``` class Grouping < Orb::BaseModel # @!attribute key # @@ -2108,12 +1927,6 @@ class Grouping < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # matrix_config => { - # dimension_values: -> { Orb::ArrayOf[String, nil?: true] === _1 } - # } - # ``` class MatrixConfig < Orb::BaseModel # @!attribute dimension_values # The ordered dimension values for this line item. @@ -2130,16 +1943,6 @@ class MatrixConfig < Orb::BaseModel end end - # @example - # ```ruby - # tier_sub_line_item => { - # amount: String, - # grouping: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::Grouping, - # name: String, - # quantity: Float, - # tier_config: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::TierConfig - # } - # ``` class TierSubLineItem < Orb::BaseModel # @!attribute amount # The total amount for this sub line item. @@ -2187,13 +1990,6 @@ class TierSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # grouping => { - # key: String, - # value: String - # } - # ``` class Grouping < Orb::BaseModel # @!attribute key # @@ -2215,14 +2011,6 @@ class Grouping < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # tier_config => { - # first_unit: Float, - # last_unit: Float, - # unit_amount: String - # } - # ``` class TierConfig < Orb::BaseModel # @!attribute first_unit # @@ -2250,16 +2038,6 @@ class TierConfig < Orb::BaseModel end end - # @example - # ```ruby - # other_sub_line_item => { - # amount: String, - # grouping: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem::Grouping, - # name: String, - # quantity: Float, - # type: :"'null'" - # } - # ``` class OtherSubLineItem < Orb::BaseModel # @!attribute amount # The total amount for this sub line item. @@ -2300,13 +2078,6 @@ class OtherSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # grouping => { - # key: String, - # value: String - # } - # ``` class Grouping < Orb::BaseModel # @!attribute key # @@ -2330,14 +2101,6 @@ class Grouping < Orb::BaseModel end end - # @example - # ```ruby - # tax_amount => { - # amount: String, - # tax_rate_description: String, - # tax_rate_percentage: String - # } - # ``` class TaxAmount < Orb::BaseModel # @!attribute amount # The amount of additional tax incurred by this tax rate. @@ -2368,13 +2131,6 @@ class TaxAmount < Orb::BaseModel end end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -2398,13 +2154,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -2428,16 +2177,6 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # payment_attempt => { - # id: String, - # amount: String, - # created_at: Time, - # payment_provider: Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider, - # payment_provider_id: String - # } - # ``` class PaymentAttempt < Orb::BaseModel # @!attribute id # The ID of the payment attempt. @@ -2512,16 +2251,6 @@ class PaymentProvider < Orb::Enum end end - # @example - # ```ruby - # shipping_address => { - # city: String, - # country: String, - # line1: String, - # line2: String, - # postal_code: String - # } - # ``` class ShippingAddress < Orb::BaseModel # @!attribute city # @@ -2598,12 +2327,6 @@ class Status < Orb::Enum # def self.values; end end - # @example - # ```ruby - # subscription => { - # id: String - # } - # ``` class Subscription < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/invoice_level_discount.rb b/lib/orb/models/invoice_level_discount.rb index 583324e4..9dea0bcc 100644 --- a/lib/orb/models/invoice_level_discount.rb +++ b/lib/orb/models/invoice_level_discount.rb @@ -9,21 +9,16 @@ module Models # case invoice_level_discount # in { # discount_type: "percentage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # percentage_discount: Float, # reason: String # } # # Orb::Models::PercentageDiscount ... - # in { - # discount_type: "amount", - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # reason: String - # } + # in {discount_type: "amount", amount_discount: String, applies_to_price_ids: ^(Orb::ArrayOf[String]), reason: String} # # Orb::Models::AmountDiscount ... # in { # discount_type: "trial", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # reason: String, # trial_amount_discount: String # } diff --git a/lib/orb/models/invoice_line_item_create_response.rb b/lib/orb/models/invoice_line_item_create_response.rb index 98e530e5..7b9c1a46 100644 --- a/lib/orb/models/invoice_line_item_create_response.rb +++ b/lib/orb/models/invoice_line_item_create_response.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # invoice_line_item_create_response => { - # id: String, - # adjusted_subtotal: String, - # adjustments: -> { Orb::ArrayOf[union: Orb::Models::InvoiceLineItemCreateResponse::Adjustment] === _1 }, - # amount: String, - # credits_applied: String, - # **_ - # } - # ``` class InvoiceLineItemCreateResponse < Orb::BaseModel # @!attribute id # A unique ID for this line item. @@ -204,12 +193,7 @@ class InvoiceLineItemCreateResponse < Orb::BaseModel # @example # ```ruby # case adjustment - # in { - # adjustment_type: "usage_discount", - # id: String, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } - # } + # in {adjustment_type: "usage_discount", id: String, amount: String, applies_to_price_ids: ^(Orb::ArrayOf[String])} # # Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment ... # in {adjustment_type: "amount_discount", id: String, amount: String, amount_discount: String} # # Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment ... @@ -217,12 +201,12 @@ class InvoiceLineItemCreateResponse < Orb::BaseModel # adjustment_type: "percentage_discount", # id: String, # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment ... - # in {adjustment_type: "minimum", id: String, amount: String, applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }} + # in {adjustment_type: "minimum", id: String, amount: String, applies_to_price_ids: ^(Orb::ArrayOf[String])} # # Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment ... - # in {adjustment_type: "maximum", id: String, amount: String, applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }} + # in {adjustment_type: "maximum", id: String, amount: String, applies_to_price_ids: ^(Orb::ArrayOf[String])} # # Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment ... # end # ``` @@ -258,17 +242,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment } - # @example - # ```ruby - # monetary_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class MonetaryUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -337,17 +310,6 @@ class MonetaryUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # monetary_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount: String, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # **_ - # } - # ``` class MonetaryAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -416,17 +378,6 @@ class MonetaryAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # monetary_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class MonetaryPercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -495,17 +446,6 @@ class MonetaryPercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # monetary_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class MonetaryMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -582,17 +522,6 @@ class MonetaryMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # monetary_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # amount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class MonetaryMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -662,13 +591,6 @@ class MonetaryMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -694,13 +616,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -775,16 +690,6 @@ class SubLineItem < Orb::Union variant :"'null'", -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem } - # @example - # ```ruby - # matrix_sub_line_item => { - # amount: String, - # grouping: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::Grouping, - # matrix_config: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::MatrixConfig, - # name: String, - # quantity: Float - # } - # ``` class MatrixSubLineItem < Orb::BaseModel # @!attribute amount # The total amount for this sub line item. @@ -832,13 +737,6 @@ class MatrixSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # grouping => { - # key: String, - # value: String - # } - # ``` class Grouping < Orb::BaseModel # @!attribute key # @@ -860,12 +758,6 @@ class Grouping < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # matrix_config => { - # dimension_values: -> { Orb::ArrayOf[String, nil?: true] === _1 } - # } - # ``` class MatrixConfig < Orb::BaseModel # @!attribute dimension_values # The ordered dimension values for this line item. @@ -882,16 +774,6 @@ class MatrixConfig < Orb::BaseModel end end - # @example - # ```ruby - # tier_sub_line_item => { - # amount: String, - # grouping: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::Grouping, - # name: String, - # quantity: Float, - # tier_config: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::TierConfig - # } - # ``` class TierSubLineItem < Orb::BaseModel # @!attribute amount # The total amount for this sub line item. @@ -939,13 +821,6 @@ class TierSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # grouping => { - # key: String, - # value: String - # } - # ``` class Grouping < Orb::BaseModel # @!attribute key # @@ -967,14 +842,6 @@ class Grouping < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # tier_config => { - # first_unit: Float, - # last_unit: Float, - # unit_amount: String - # } - # ``` class TierConfig < Orb::BaseModel # @!attribute first_unit # @@ -1002,16 +869,6 @@ class TierConfig < Orb::BaseModel end end - # @example - # ```ruby - # other_sub_line_item => { - # amount: String, - # grouping: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem::Grouping, - # name: String, - # quantity: Float, - # type: :"'null'" - # } - # ``` class OtherSubLineItem < Orb::BaseModel # @!attribute amount # The total amount for this sub line item. @@ -1052,13 +909,6 @@ class OtherSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # grouping => { - # key: String, - # value: String - # } - # ``` class Grouping < Orb::BaseModel # @!attribute key # @@ -1082,14 +932,6 @@ class Grouping < Orb::BaseModel end end - # @example - # ```ruby - # tax_amount => { - # amount: String, - # tax_rate_description: String, - # tax_rate_percentage: String - # } - # ``` class TaxAmount < Orb::BaseModel # @!attribute amount # The amount of additional tax incurred by this tax rate. diff --git a/lib/orb/models/item.rb b/lib/orb/models/item.rb index a59f512e..807a1c4d 100644 --- a/lib/orb/models/item.rb +++ b/lib/orb/models/item.rb @@ -2,15 +2,6 @@ module Orb module Models - # @example - # ```ruby - # item => { - # id: String, - # created_at: Time, - # external_connections: -> { Orb::ArrayOf[Orb::Models::Item::ExternalConnection] === _1 }, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -46,13 +37,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # external_connection => { - # external_connection_name: Orb::Models::Item::ExternalConnection::ExternalConnectionName, - # external_entity_id: String - # } - # ``` class ExternalConnection < Orb::BaseModel # @!attribute external_connection_name # diff --git a/lib/orb/models/item_update_params.rb b/lib/orb/models/item_update_params.rb index 9e04c243..ab125fd5 100644 --- a/lib/orb/models/item_update_params.rb +++ b/lib/orb/models/item_update_params.rb @@ -28,13 +28,6 @@ class ItemUpdateParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # external_connection => { - # external_connection_name: Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName, - # external_entity_id: String - # } - # ``` class ExternalConnection < Orb::BaseModel # @!attribute external_connection_name # diff --git a/lib/orb/models/pagination_metadata.rb b/lib/orb/models/pagination_metadata.rb index 0da216cd..e14dd832 100644 --- a/lib/orb/models/pagination_metadata.rb +++ b/lib/orb/models/pagination_metadata.rb @@ -2,13 +2,6 @@ module Orb module Models - # @example - # ```ruby - # pagination_metadata => { - # has_more: Orb::BooleanModel, - # next_cursor: String - # } - # ``` class PaginationMetadata < Orb::BaseModel # @!attribute has_more # diff --git a/lib/orb/models/percentage_discount.rb b/lib/orb/models/percentage_discount.rb index 1b0c442d..ba2c3a33 100644 --- a/lib/orb/models/percentage_discount.rb +++ b/lib/orb/models/percentage_discount.rb @@ -2,15 +2,6 @@ module Orb module Models - # @example - # ```ruby - # percentage_discount => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: Orb::Models::PercentageDiscount::DiscountType, - # percentage_discount: Float, - # reason: String - # } - # ``` class PercentageDiscount < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this discount applies to. For plan/plan phase discounts, diff --git a/lib/orb/models/plan.rb b/lib/orb/models/plan.rb index eb36c1e7..6e8e446c 100644 --- a/lib/orb/models/plan.rb +++ b/lib/orb/models/plan.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # plan => { - # id: String, - # adjustments: -> { Orb::ArrayOf[union: Orb::Models::Plan::Adjustment] === _1 }, - # base_plan: Orb::Models::Plan::BasePlan, - # base_plan_id: String, - # created_at: Time, - # **_ - # } - # ``` class Plan < Orb::BaseModel # @!attribute id # @@ -229,7 +218,7 @@ class Plan < Orb::BaseModel # in { # adjustment_type: "usage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment ... @@ -237,27 +226,27 @@ class Plan < Orb::BaseModel # adjustment_type: "amount_discount", # id: String, # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment ... # in { # adjustment_type: "percentage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment ... # in { # adjustment_type: "minimum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment ... # in { # adjustment_type: "maximum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment ... @@ -292,17 +281,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment } - # @example - # ```ruby - # plan_phase_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # plan_phase_order: Integer, - # **_ - # } - # ``` class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -371,17 +349,6 @@ class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -450,17 +417,6 @@ class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # percentage_discount: Float, - # **_ - # } - # ``` class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -529,17 +485,6 @@ class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # item_id: String, - # **_ - # } - # ``` class PlanPhaseMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -616,17 +561,6 @@ class PlanPhaseMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # maximum_amount: String, - # **_ - # } - # ``` class PlanPhaseMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -696,14 +630,6 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # base_plan => { - # id: String, - # external_plan_id: String, - # name: String - # } - # ``` class BasePlan < Orb::BaseModel # @!attribute id # @@ -733,13 +659,6 @@ class BasePlan < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -763,13 +682,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -793,17 +705,6 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase => { - # id: String, - # description: String, - # discount: Orb::Models::Discount, - # duration: Integer, - # duration_unit: Orb::Models::Plan::PlanPhase::DurationUnit, - # **_ - # } - # ``` class PlanPhase < Orb::BaseModel # @!attribute id # @@ -927,13 +828,6 @@ class DurationUnit < Orb::Enum # def self.values; end end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -957,13 +851,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -988,14 +875,6 @@ class Minimum < Orb::BaseModel end end - # @example - # ```ruby - # product => { - # id: String, - # created_at: Time, - # name: String - # } - # ``` class Product < Orb::BaseModel # @!attribute id # @@ -1048,13 +927,6 @@ class Status < Orb::Enum # def self.values; end end - # @example - # ```ruby - # trial_config => { - # trial_period: Integer, - # trial_period_unit: Orb::Models::Plan::TrialConfig::TrialPeriodUnit - # } - # ``` class TrialConfig < Orb::BaseModel # @!attribute trial_period # diff --git a/lib/orb/models/plan_create_params.rb b/lib/orb/models/plan_create_params.rb index c2a19d1a..acad8938 100644 --- a/lib/orb/models/plan_create_params.rb +++ b/lib/orb/models/plan_create_params.rb @@ -205,21 +205,21 @@ class PlanCreateParams < Orb::BaseModel # in { # model_type: "grouped_allocation", # cadence: Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence, - # grouped_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # grouped_allocation_config: ^(Orb::HashOf[Orb::Unknown]), # item_id: String # } # # Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice ... # in { # model_type: "grouped_with_prorated_minimum", # cadence: Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::Cadence, - # grouped_with_prorated_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # grouped_with_prorated_minimum_config: ^(Orb::HashOf[Orb::Unknown]), # item_id: String # } # # Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice ... # in { # model_type: "grouped_with_metered_minimum", # cadence: Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::Cadence, - # grouped_with_metered_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # grouped_with_metered_minimum_config: ^(Orb::HashOf[Orb::Unknown]), # item_id: String # } # # Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice ... @@ -227,12 +227,12 @@ class PlanCreateParams < Orb::BaseModel # model_type: "matrix_with_display_name", # cadence: Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::Cadence, # item_id: String, - # matrix_with_display_name_config: -> { Orb::HashOf[Orb::Unknown] === _1 } + # matrix_with_display_name_config: ^(Orb::HashOf[Orb::Unknown]) # } # # Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice ... # in { # model_type: "bulk_with_proration", - # bulk_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # bulk_with_proration_config: ^(Orb::HashOf[Orb::Unknown]), # cadence: Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence, # item_id: String # } @@ -240,7 +240,7 @@ class PlanCreateParams < Orb::BaseModel # in { # model_type: "grouped_tiered_package", # cadence: Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::Cadence, - # grouped_tiered_package_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # grouped_tiered_package_config: ^(Orb::HashOf[Orb::Unknown]), # item_id: String # } # # Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice ... @@ -248,7 +248,7 @@ class PlanCreateParams < Orb::BaseModel # model_type: "max_group_tiered_package", # cadence: Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::Cadence, # item_id: String, - # max_group_tiered_package_config: -> { Orb::HashOf[Orb::Unknown] === _1 } + # max_group_tiered_package_config: ^(Orb::HashOf[Orb::Unknown]) # } # # Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice ... # in { @@ -268,7 +268,7 @@ class PlanCreateParams < Orb::BaseModel # in { # model_type: "cumulative_grouped_bulk", # cadence: Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::Cadence, - # cumulative_grouped_bulk_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # cumulative_grouped_bulk_config: ^(Orb::HashOf[Orb::Unknown]), # item_id: String # } # # Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice ... @@ -393,17 +393,6 @@ class Price < Orb::Union variant :cumulative_grouped_bulk, -> { Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice } - # @example - # ```ruby - # new_plan_unit_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence, - # item_id: String, - # model_type: :unit, - # name: String, - # unit_config: Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::UnitConfig, - # **_ - # } - # ``` class NewPlanUnitPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -412,7 +401,7 @@ class NewPlanUnitPrice < Orb::BaseModel required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -582,12 +571,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # unit_config => { - # unit_amount: String - # } - # ``` class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -603,13 +586,6 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -661,13 +637,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -720,17 +689,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_package_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence, - # item_id: String, - # model_type: :package, - # name: String, - # package_config: Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::PackageConfig, - # **_ - # } - # ``` class NewPlanPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -739,7 +697,7 @@ class NewPlanPackagePrice < Orb::BaseModel required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -909,13 +867,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # package_config => { - # package_amount: String, - # package_size: Integer - # } - # ``` class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -939,13 +890,6 @@ class PackageConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -997,13 +941,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1056,17 +993,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_matrix_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence, - # item_id: String, - # matrix_config: Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::MatrixConfig, - # model_type: :matrix, - # name: String, - # **_ - # } - # ``` class NewPlanMatrixPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -1075,7 +1001,7 @@ class NewPlanMatrixPrice < Orb::BaseModel required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -1245,14 +1171,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # matrix_config => { - # default_unit_amount: String, - # dimensions: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # matrix_values: -> { Orb::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::MatrixConfig::MatrixValue] === _1 } - # } - # ``` class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -1282,13 +1200,6 @@ class MatrixConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # matrix_value => { - # dimension_values: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # unit_amount: String - # } - # ``` class MatrixValue < Orb::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -1314,13 +1225,6 @@ class MatrixValue < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1372,13 +1276,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1431,17 +1328,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_tiered_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence, - # item_id: String, - # model_type: :tiered, - # name: String, - # tiered_config: Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::TieredConfig, - # **_ - # } - # ``` class NewPlanTieredPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -1450,7 +1336,7 @@ class NewPlanTieredPrice < Orb::BaseModel required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -1620,12 +1506,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # tiered_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::TieredConfig::Tier] === _1 } - # } - # ``` class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -1641,14 +1521,6 @@ class TieredConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # first_unit: Float, - # unit_amount: String, - # last_unit: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute first_unit # Inclusive tier starting value @@ -1679,13 +1551,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1737,13 +1602,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1796,17 +1654,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_tiered_bps_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence, - # item_id: String, - # model_type: :tiered_bps, - # name: String, - # tiered_bps_config: Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig, - # **_ - # } - # ``` class NewPlanTieredBpsPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -1815,7 +1662,7 @@ class NewPlanTieredBpsPrice < Orb::BaseModel required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -1986,12 +1833,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # tiered_bps_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig::Tier] === _1 } - # } - # ``` class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -2008,15 +1849,6 @@ class TieredBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # minimum_amount: String, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Per-event basis point rate @@ -2054,13 +1886,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2112,13 +1937,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2171,17 +1989,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_bps_price => { - # bps_config: Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BpsConfig, - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence, - # item_id: String, - # model_type: :bps, - # name: String, - # **_ - # } - # ``` class NewPlanBpsPrice < Orb::BaseModel # @!attribute bps_config # @@ -2195,7 +2002,7 @@ class NewPlanBpsPrice < Orb::BaseModel required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -2323,13 +2130,6 @@ class NewPlanBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bps_config => { - # bps: Float, - # per_unit_maximum: String - # } - # ``` class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -2389,13 +2189,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2447,13 +2240,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2506,17 +2292,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_bulk_bps_price => { - # bulk_bps_config: Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig, - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence, - # item_id: String, - # model_type: :bulk_bps, - # name: String, - # **_ - # } - # ``` class NewPlanBulkBpsPrice < Orb::BaseModel # @!attribute bulk_bps_config # @@ -2530,7 +2305,7 @@ class NewPlanBulkBpsPrice < Orb::BaseModel required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -2658,12 +2433,6 @@ class NewPlanBulkBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bulk_bps_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig::Tier] === _1 } - # } - # ``` class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -2680,14 +2449,6 @@ class BulkBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Basis points to rate on @@ -2755,13 +2516,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2813,13 +2567,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2872,17 +2619,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_bulk_price => { - # bulk_config: Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BulkConfig, - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence, - # item_id: String, - # model_type: :bulk, - # name: String, - # **_ - # } - # ``` class NewPlanBulkPrice < Orb::BaseModel # @!attribute bulk_config # @@ -2896,7 +2632,7 @@ class NewPlanBulkPrice < Orb::BaseModel required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -3024,12 +2760,6 @@ class NewPlanBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bulk_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BulkConfig::Tier] === _1 } - # } - # ``` class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -3045,13 +2775,6 @@ class BulkConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # unit_amount: String, - # maximum_units: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute unit_amount # Amount per unit @@ -3112,13 +2835,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3170,13 +2886,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3229,17 +2938,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_threshold_total_amount_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::Cadence, - # item_id: String, - # model_type: :threshold_total_amount, - # name: String, - # threshold_total_amount_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewPlanThresholdTotalAmountPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -3249,7 +2947,7 @@ class NewPlanThresholdTotalAmountPrice < Orb::BaseModel enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -3419,13 +3117,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3477,13 +3168,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3536,17 +3220,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_tiered_package_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence, - # item_id: String, - # model_type: :tiered_package, - # name: String, - # tiered_package_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewPlanTieredPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -3555,7 +3228,7 @@ class NewPlanTieredPackagePrice < Orb::BaseModel required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -3725,13 +3398,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3783,13 +3449,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3842,17 +3501,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_tiered_with_minimum_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence, - # item_id: String, - # model_type: :tiered_with_minimum, - # name: String, - # tiered_with_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewPlanTieredWithMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -3862,7 +3510,7 @@ class NewPlanTieredWithMinimumPrice < Orb::BaseModel enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -4032,13 +3680,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4090,13 +3731,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4149,17 +3783,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_unit_with_percent_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence, - # item_id: String, - # model_type: :unit_with_percent, - # name: String, - # unit_with_percent_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewPlanUnitWithPercentPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -4168,7 +3791,7 @@ class NewPlanUnitWithPercentPrice < Orb::BaseModel required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -4338,13 +3961,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4396,13 +4012,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4455,17 +4064,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_package_with_allocation_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::Cadence, - # item_id: String, - # model_type: :package_with_allocation, - # name: String, - # package_with_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewPlanPackageWithAllocationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -4475,7 +4073,7 @@ class NewPlanPackageWithAllocationPrice < Orb::BaseModel enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -4645,13 +4243,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4703,13 +4294,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4762,17 +4346,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_tier_with_proration_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence, - # item_id: String, - # model_type: :tiered_with_proration, - # name: String, - # tiered_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewPlanTierWithProrationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -4782,7 +4355,7 @@ class NewPlanTierWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -4952,13 +4525,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5010,13 +4576,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5069,17 +4628,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_unit_with_proration_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence, - # item_id: String, - # model_type: :unit_with_proration, - # name: String, - # unit_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewPlanUnitWithProrationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -5089,7 +4637,7 @@ class NewPlanUnitWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -5259,13 +4807,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5317,13 +4858,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5376,17 +4910,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_grouped_allocation_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence, - # grouped_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_allocation, - # name: String, - # **_ - # } - # ``` class NewPlanGroupedAllocationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -5401,7 +4924,7 @@ class NewPlanGroupedAllocationPrice < Orb::BaseModel required :grouped_allocation_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -5566,13 +5089,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5624,13 +5140,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5683,17 +5192,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_grouped_with_prorated_minimum_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::Cadence, - # grouped_with_prorated_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_with_prorated_minimum, - # name: String, - # **_ - # } - # ``` class NewPlanGroupedWithProratedMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -5708,7 +5206,7 @@ class NewPlanGroupedWithProratedMinimumPrice < Orb::BaseModel required :grouped_with_prorated_minimum_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -5873,13 +5371,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5931,13 +5422,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5990,17 +5474,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_grouped_with_metered_minimum_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::Cadence, - # grouped_with_metered_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_with_metered_minimum, - # name: String, - # **_ - # } - # ``` class NewPlanGroupedWithMeteredMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -6015,7 +5488,7 @@ class NewPlanGroupedWithMeteredMinimumPrice < Orb::BaseModel required :grouped_with_metered_minimum_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -6180,13 +5653,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6238,13 +5704,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6297,17 +5756,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_matrix_with_display_name_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::Cadence, - # item_id: String, - # matrix_with_display_name_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # model_type: :matrix_with_display_name, - # name: String, - # **_ - # } - # ``` class NewPlanMatrixWithDisplayNamePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -6317,7 +5765,7 @@ class NewPlanMatrixWithDisplayNamePrice < Orb::BaseModel enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -6487,13 +5935,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6545,13 +5986,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6604,17 +6038,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_bulk_with_proration_price => { - # bulk_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence, - # item_id: String, - # model_type: :bulk_with_proration, - # name: String, - # **_ - # } - # ``` class NewPlanBulkWithProrationPrice < Orb::BaseModel # @!attribute bulk_with_proration_config # @@ -6629,7 +6052,7 @@ class NewPlanBulkWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -6794,13 +6217,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6852,13 +6268,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6911,17 +6320,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_grouped_tiered_package_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::Cadence, - # grouped_tiered_package_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_tiered_package, - # name: String, - # **_ - # } - # ``` class NewPlanGroupedTieredPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -6936,7 +6334,7 @@ class NewPlanGroupedTieredPackagePrice < Orb::BaseModel required :grouped_tiered_package_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -7101,13 +6499,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7159,13 +6550,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7218,17 +6602,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_max_group_tiered_package_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::Cadence, - # item_id: String, - # max_group_tiered_package_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # model_type: :max_group_tiered_package, - # name: String, - # **_ - # } - # ``` class NewPlanMaxGroupTieredPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -7238,7 +6611,7 @@ class NewPlanMaxGroupTieredPackagePrice < Orb::BaseModel enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -7408,13 +6781,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7466,13 +6832,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7525,17 +6884,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_scalable_matrix_with_unit_pricing_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::Cadence, - # item_id: String, - # model_type: :scalable_matrix_with_unit_pricing, - # name: String, - # scalable_matrix_with_unit_pricing_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewPlanScalableMatrixWithUnitPricingPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -7545,7 +6893,7 @@ class NewPlanScalableMatrixWithUnitPricingPrice < Orb::BaseModel enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -7715,13 +7063,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7773,13 +7114,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7832,17 +7166,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_scalable_matrix_with_tiered_pricing_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::Cadence, - # item_id: String, - # model_type: :scalable_matrix_with_tiered_pricing, - # name: String, - # scalable_matrix_with_tiered_pricing_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewPlanScalableMatrixWithTieredPricingPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -7852,7 +7175,7 @@ class NewPlanScalableMatrixWithTieredPricingPrice < Orb::BaseModel enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -8022,13 +7345,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8080,13 +7396,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8139,17 +7448,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_plan_cumulative_grouped_bulk_price => { - # cadence: Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::Cadence, - # cumulative_grouped_bulk_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :cumulative_grouped_bulk, - # name: String, - # **_ - # } - # ``` class NewPlanCumulativeGroupedBulkPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -8164,7 +7462,7 @@ class NewPlanCumulativeGroupedBulkPrice < Orb::BaseModel required :cumulative_grouped_bulk_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -8329,13 +7627,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8387,13 +7678,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. diff --git a/lib/orb/models/price.rb b/lib/orb/models/price.rb index db62ad87..78754084 100644 --- a/lib/orb/models/price.rb +++ b/lib/orb/models/price.rb @@ -338,17 +338,6 @@ class Price < Orb::Union variant :cumulative_grouped_bulk, -> { Orb::Models::Price::CumulativeGroupedBulkPrice } - # @example - # ```ruby - # unit_price => { - # id: String, - # billable_metric: Orb::Models::Price::UnitPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::UnitPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::UnitPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class UnitPrice < Orb::BaseModel # @!attribute id # @@ -536,12 +525,6 @@ class UnitPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -556,13 +539,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::UnitPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -642,13 +618,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -669,13 +638,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -720,13 +682,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -747,13 +702,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -777,13 +725,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -830,12 +771,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # unit_config => { - # unit_amount: String - # } - # ``` class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -851,13 +786,6 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -879,17 +807,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # package_price => { - # id: String, - # billable_metric: Orb::Models::Price::PackagePrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::PackagePrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::PackagePrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class PackagePrice < Orb::BaseModel # @!attribute id # @@ -1077,12 +994,6 @@ class PackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -1097,13 +1008,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::PackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -1183,13 +1087,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -1210,13 +1107,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -1261,13 +1151,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -1288,13 +1171,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -1318,13 +1194,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -1348,13 +1217,6 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # package_config => { - # package_amount: String, - # package_size: Integer - # } - # ``` class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -1401,13 +1263,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -1429,17 +1284,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # matrix_price => { - # id: String, - # billable_metric: Orb::Models::Price::MatrixPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::MatrixPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::MatrixPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class MatrixPrice < Orb::BaseModel # @!attribute id # @@ -1627,12 +1471,6 @@ class MatrixPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -1647,13 +1485,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::MatrixPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -1733,13 +1564,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -1760,13 +1584,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -1811,13 +1628,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -1838,14 +1648,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # matrix_config => { - # default_unit_amount: String, - # dimensions: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # matrix_values: -> { Orb::ArrayOf[Orb::Models::Price::MatrixPrice::MatrixConfig::MatrixValue] === _1 } - # } - # ``` class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -1874,13 +1676,6 @@ class MatrixConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # matrix_value => { - # dimension_values: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # unit_amount: String - # } - # ``` class MatrixValue < Orb::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -1906,13 +1701,6 @@ class MatrixValue < Orb::BaseModel end end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -1936,13 +1724,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -1989,13 +1770,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -2017,17 +1791,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # tiered_price => { - # id: String, - # billable_metric: Orb::Models::Price::TieredPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::TieredPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::TieredPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class TieredPrice < Orb::BaseModel # @!attribute id # @@ -2215,12 +1978,6 @@ class TieredPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -2235,13 +1992,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::TieredPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -2321,13 +2071,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -2348,13 +2091,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -2399,13 +2135,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -2426,13 +2155,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -2456,13 +2178,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -2509,12 +2224,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # tiered_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::Price::TieredPrice::TieredConfig::Tier] === _1 } - # } - # ``` class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -2529,14 +2238,6 @@ class TieredConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # first_unit: Float, - # unit_amount: String, - # last_unit: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute first_unit # Inclusive tier starting value @@ -2567,13 +2268,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -2595,17 +2289,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # tiered_bps_price => { - # id: String, - # billable_metric: Orb::Models::Price::TieredBpsPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::TieredBpsPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class TieredBpsPrice < Orb::BaseModel # @!attribute id # @@ -2794,12 +2477,6 @@ class TieredBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -2814,13 +2491,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -2900,13 +2570,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -2927,13 +2590,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -2978,13 +2634,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -3005,13 +2654,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -3035,13 +2677,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -3088,12 +2723,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # tiered_bps_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::Price::TieredBpsPrice::TieredBpsConfig::Tier] === _1 } - # } - # ``` class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -3109,15 +2738,6 @@ class TieredBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # minimum_amount: String, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Per-event basis point rate @@ -3155,13 +2775,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -3183,17 +2796,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # bps_price => { - # id: String, - # billable_metric: Orb::Models::Price::BpsPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::BpsPrice::BillingCycleConfiguration, - # bps_config: Orb::Models::Price::BpsPrice::BpsConfig, - # cadence: Orb::Models::Price::BpsPrice::Cadence, - # **_ - # } - # ``` class BpsPrice < Orb::BaseModel # @!attribute id # @@ -3381,12 +2983,6 @@ class BpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -3401,13 +2997,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::BpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -3452,13 +3041,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # bps_config => { - # bps: Float, - # per_unit_maximum: String - # } - # ``` class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -3516,13 +3098,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -3543,13 +3118,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -3594,13 +3162,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -3621,13 +3182,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -3651,13 +3205,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -3704,13 +3251,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -3732,17 +3272,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # bulk_bps_price => { - # id: String, - # billable_metric: Orb::Models::Price::BulkBpsPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration, - # bulk_bps_config: Orb::Models::Price::BulkBpsPrice::BulkBpsConfig, - # cadence: Orb::Models::Price::BulkBpsPrice::Cadence, - # **_ - # } - # ``` class BulkBpsPrice < Orb::BaseModel # @!attribute id # @@ -3930,12 +3459,6 @@ class BulkBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -3950,13 +3473,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -4001,12 +3517,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # bulk_bps_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::Price::BulkBpsPrice::BulkBpsConfig::Tier] === _1 } - # } - # ``` class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -4022,14 +3532,6 @@ class BulkBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Basis points to rate on @@ -4095,13 +3597,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -4122,13 +3617,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -4173,13 +3661,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -4200,13 +3681,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -4230,13 +3704,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -4283,13 +3750,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -4311,17 +3771,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # bulk_price => { - # id: String, - # billable_metric: Orb::Models::Price::BulkPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::BulkPrice::BillingCycleConfiguration, - # bulk_config: Orb::Models::Price::BulkPrice::BulkConfig, - # cadence: Orb::Models::Price::BulkPrice::Cadence, - # **_ - # } - # ``` class BulkPrice < Orb::BaseModel # @!attribute id # @@ -4509,12 +3958,6 @@ class BulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -4529,13 +3972,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::BulkPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -4580,12 +4016,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # bulk_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::Price::BulkPrice::BulkConfig::Tier] === _1 } - # } - # ``` class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -4600,13 +4030,6 @@ class BulkConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # unit_amount: String, - # maximum_units: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute unit_amount # Amount per unit @@ -4665,13 +4088,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -4692,13 +4108,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -4743,13 +4152,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -4770,13 +4172,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -4800,13 +4195,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -4853,13 +4241,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -4881,17 +4262,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # threshold_total_amount_price => { - # id: String, - # billable_metric: Orb::Models::Price::ThresholdTotalAmountPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::ThresholdTotalAmountPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::ThresholdTotalAmountPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class ThresholdTotalAmountPrice < Orb::BaseModel # @!attribute id # @@ -5084,12 +4454,6 @@ class ThresholdTotalAmountPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -5104,13 +4468,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::ThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -5190,13 +4547,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -5217,13 +4567,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::ThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -5268,13 +4611,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -5295,13 +4631,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -5325,13 +4654,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -5378,13 +4700,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -5406,17 +4721,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # tiered_package_price => { - # id: String, - # billable_metric: Orb::Models::Price::TieredPackagePrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::TieredPackagePrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::TieredPackagePrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class TieredPackagePrice < Orb::BaseModel # @!attribute id # @@ -5605,12 +4909,6 @@ class TieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -5625,13 +4923,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::TieredPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -5711,13 +5002,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -5738,13 +5022,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::TieredPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -5789,13 +5066,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -5816,13 +5086,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -5846,13 +5109,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -5899,13 +5155,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -5927,17 +5176,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # grouped_tiered_price => { - # id: String, - # billable_metric: Orb::Models::Price::GroupedTieredPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::GroupedTieredPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::GroupedTieredPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class GroupedTieredPrice < Orb::BaseModel # @!attribute id # @@ -6126,12 +5364,6 @@ class GroupedTieredPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -6146,13 +5378,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::GroupedTieredPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -6232,13 +5457,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -6259,13 +5477,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::GroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -6310,13 +5521,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -6337,13 +5541,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -6367,13 +5564,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -6420,13 +5610,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -6448,17 +5631,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # tiered_with_minimum_price => { - # id: String, - # billable_metric: Orb::Models::Price::TieredWithMinimumPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::TieredWithMinimumPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::TieredWithMinimumPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class TieredWithMinimumPrice < Orb::BaseModel # @!attribute id # @@ -6649,12 +5821,6 @@ class TieredWithMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -6669,13 +5835,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::TieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -6755,13 +5914,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -6782,13 +5934,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::TieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -6833,13 +5978,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -6860,13 +5998,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -6890,13 +6021,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -6943,13 +6067,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -6971,17 +6088,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # tiered_package_with_minimum_price => { - # id: String, - # billable_metric: Orb::Models::Price::TieredPackageWithMinimumPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::TieredPackageWithMinimumPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::TieredPackageWithMinimumPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class TieredPackageWithMinimumPrice < Orb::BaseModel # @!attribute id # @@ -7174,12 +6280,6 @@ class TieredPackageWithMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -7194,13 +6294,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::TieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -7280,13 +6373,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -7307,13 +6393,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::TieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -7358,13 +6437,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -7385,13 +6457,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -7415,13 +6480,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -7468,13 +6526,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -7496,17 +6547,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # package_with_allocation_price => { - # id: String, - # billable_metric: Orb::Models::Price::PackageWithAllocationPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::PackageWithAllocationPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::PackageWithAllocationPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class PackageWithAllocationPrice < Orb::BaseModel # @!attribute id # @@ -7699,12 +6739,6 @@ class PackageWithAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -7719,13 +6753,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::PackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -7805,13 +6832,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -7832,13 +6852,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::PackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -7883,13 +6896,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -7910,13 +6916,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -7940,13 +6939,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -7993,13 +6985,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -8021,17 +7006,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # unit_with_percent_price => { - # id: String, - # billable_metric: Orb::Models::Price::UnitWithPercentPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::UnitWithPercentPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::UnitWithPercentPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class UnitWithPercentPrice < Orb::BaseModel # @!attribute id # @@ -8220,12 +7194,6 @@ class UnitWithPercentPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -8240,13 +7208,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::UnitWithPercentPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -8326,13 +7287,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -8353,13 +7307,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::UnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -8404,13 +7351,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -8431,13 +7371,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -8461,13 +7394,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -8514,13 +7440,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -8542,17 +7461,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # matrix_with_allocation_price => { - # id: String, - # billable_metric: Orb::Models::Price::MatrixWithAllocationPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::MatrixWithAllocationPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::MatrixWithAllocationPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class MatrixWithAllocationPrice < Orb::BaseModel # @!attribute id # @@ -8746,12 +7654,6 @@ class MatrixWithAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -8766,13 +7668,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::MatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -8852,13 +7747,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -8879,13 +7767,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::MatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -8930,13 +7811,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -8957,15 +7831,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # matrix_with_allocation_config => { - # allocation: Float, - # default_unit_amount: String, - # dimensions: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # matrix_values: -> { Orb::ArrayOf[Orb::Models::Price::MatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue] === _1 } - # } - # ``` class MatrixWithAllocationConfig < Orb::BaseModel # @!attribute allocation # Allocation to be used to calculate the price @@ -9002,13 +7867,6 @@ class MatrixWithAllocationConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # matrix_value => { - # dimension_values: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # unit_amount: String - # } - # ``` class MatrixValue < Orb::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -9034,13 +7892,6 @@ class MatrixValue < Orb::BaseModel end end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -9064,13 +7915,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -9117,13 +7961,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -9145,17 +7982,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # tiered_with_proration_price => { - # id: String, - # billable_metric: Orb::Models::Price::TieredWithProrationPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::TieredWithProrationPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::TieredWithProrationPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class TieredWithProrationPrice < Orb::BaseModel # @!attribute id # @@ -9346,12 +8172,6 @@ class TieredWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -9366,13 +8186,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::TieredWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -9452,13 +8265,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -9479,13 +8285,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::TieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -9530,13 +8329,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -9557,13 +8349,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -9587,13 +8372,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -9640,13 +8418,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -9668,17 +8439,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # unit_with_proration_price => { - # id: String, - # billable_metric: Orb::Models::Price::UnitWithProrationPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::UnitWithProrationPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::UnitWithProrationPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class UnitWithProrationPrice < Orb::BaseModel # @!attribute id # @@ -9869,12 +8629,6 @@ class UnitWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -9889,13 +8643,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::UnitWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -9974,14 +8721,7 @@ class Cadence < Orb::Enum # # # def self.values; end end - - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` + class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -10002,13 +8742,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::UnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -10053,13 +8786,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -10080,13 +8806,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -10110,13 +8829,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -10163,13 +8875,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -10191,17 +8896,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # grouped_allocation_price => { - # id: String, - # billable_metric: Orb::Models::Price::GroupedAllocationPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::GroupedAllocationPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::GroupedAllocationPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class GroupedAllocationPrice < Orb::BaseModel # @!attribute id # @@ -10392,12 +9086,6 @@ class GroupedAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -10412,13 +9100,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::GroupedAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -10498,13 +9179,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -10525,13 +9199,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::GroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -10576,13 +9243,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -10603,13 +9263,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -10633,13 +9286,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -10686,13 +9332,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -10714,17 +9353,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # grouped_with_prorated_minimum_price => { - # id: String, - # billable_metric: Orb::Models::Price::GroupedWithProratedMinimumPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::GroupedWithProratedMinimumPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::GroupedWithProratedMinimumPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class GroupedWithProratedMinimumPrice < Orb::BaseModel # @!attribute id # @@ -10917,12 +9545,6 @@ class GroupedWithProratedMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -10937,13 +9559,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::GroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -11023,13 +9638,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -11050,13 +9658,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::GroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -11101,13 +9702,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -11128,13 +9722,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -11158,13 +9745,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -11211,13 +9791,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -11239,17 +9812,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # grouped_with_metered_minimum_price => { - # id: String, - # billable_metric: Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::GroupedWithMeteredMinimumPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class GroupedWithMeteredMinimumPrice < Orb::BaseModel # @!attribute id # @@ -11442,12 +10004,6 @@ class GroupedWithMeteredMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -11462,13 +10018,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -11548,13 +10097,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -11575,13 +10117,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::GroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -11626,13 +10161,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -11653,13 +10181,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -11683,13 +10204,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -11736,13 +10250,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -11764,17 +10271,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # matrix_with_display_name_price => { - # id: String, - # billable_metric: Orb::Models::Price::MatrixWithDisplayNamePrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::MatrixWithDisplayNamePrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::MatrixWithDisplayNamePrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class MatrixWithDisplayNamePrice < Orb::BaseModel # @!attribute id # @@ -11967,12 +10463,6 @@ class MatrixWithDisplayNamePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -11987,13 +10477,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::MatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -12073,13 +10556,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -12100,13 +10576,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::MatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -12151,13 +10620,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -12178,13 +10640,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -12208,13 +10663,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -12261,13 +10709,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -12289,17 +10730,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # bulk_with_proration_price => { - # id: String, - # billable_metric: Orb::Models::Price::BulkWithProrationPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::BulkWithProrationPrice::BillingCycleConfiguration, - # bulk_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # cadence: Orb::Models::Price::BulkWithProrationPrice::Cadence, - # **_ - # } - # ``` class BulkWithProrationPrice < Orb::BaseModel # @!attribute id # @@ -12490,12 +10920,6 @@ class BulkWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -12510,13 +10934,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::BulkWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -12596,13 +11013,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -12623,13 +11033,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::BulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -12674,13 +11077,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -12701,13 +11097,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -12731,13 +11120,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -12784,13 +11166,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -12812,17 +11187,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # grouped_tiered_package_price => { - # id: String, - # billable_metric: Orb::Models::Price::GroupedTieredPackagePrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::GroupedTieredPackagePrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::GroupedTieredPackagePrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class GroupedTieredPackagePrice < Orb::BaseModel # @!attribute id # @@ -13015,12 +11379,6 @@ class GroupedTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -13035,13 +11393,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::GroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -13121,13 +11472,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -13148,13 +11492,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::GroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -13199,13 +11536,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -13226,13 +11556,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -13256,13 +11579,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -13309,13 +11625,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -13337,17 +11646,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # max_group_tiered_package_price => { - # id: String, - # billable_metric: Orb::Models::Price::MaxGroupTieredPackagePrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::MaxGroupTieredPackagePrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::MaxGroupTieredPackagePrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class MaxGroupTieredPackagePrice < Orb::BaseModel # @!attribute id # @@ -13540,12 +11838,6 @@ class MaxGroupTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -13560,13 +11852,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::MaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -13646,13 +11931,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -13673,13 +11951,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::MaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -13724,13 +11995,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -13751,13 +12015,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -13781,13 +12038,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -13834,13 +12084,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -13862,17 +12105,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # scalable_matrix_with_unit_pricing_price => { - # id: String, - # billable_metric: Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class ScalableMatrixWithUnitPricingPrice < Orb::BaseModel # @!attribute id # @@ -14065,12 +12297,6 @@ class ScalableMatrixWithUnitPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -14085,13 +12311,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -14171,13 +12390,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -14198,13 +12410,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -14249,13 +12454,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -14276,13 +12474,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -14306,13 +12497,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -14359,13 +12543,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -14387,17 +12564,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # scalable_matrix_with_tiered_pricing_price => { - # id: String, - # billable_metric: Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class ScalableMatrixWithTieredPricingPrice < Orb::BaseModel # @!attribute id # @@ -14590,12 +12756,6 @@ class ScalableMatrixWithTieredPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -14610,13 +12770,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -14696,13 +12849,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -14723,13 +12869,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -14774,13 +12913,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -14801,13 +12933,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -14831,13 +12956,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -14884,13 +13002,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -14912,17 +13023,6 @@ class DimensionalPriceConfiguration < Orb::BaseModel end end - # @example - # ```ruby - # cumulative_grouped_bulk_price => { - # id: String, - # billable_metric: Orb::Models::Price::CumulativeGroupedBulkPrice::BillableMetric, - # billing_cycle_configuration: Orb::Models::Price::CumulativeGroupedBulkPrice::BillingCycleConfiguration, - # cadence: Orb::Models::Price::CumulativeGroupedBulkPrice::Cadence, - # conversion_rate: Float, - # **_ - # } - # ``` class CumulativeGroupedBulkPrice < Orb::BaseModel # @!attribute id # @@ -15115,12 +13215,6 @@ class CumulativeGroupedBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -15135,13 +13229,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::CumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -15221,13 +13308,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # credit_allocation => { - # allows_rollover: Orb::BooleanModel, - # currency: String - # } - # ``` class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -15248,13 +13328,6 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::Price::CumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -15299,13 +13372,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # item => { - # id: String, - # name: String - # } - # ``` class Item < Orb::BaseModel # @!attribute id # @@ -15326,13 +13392,6 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String - # } - # ``` class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -15356,13 +13415,6 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # minimum_amount: String - # } - # ``` class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -15409,13 +13461,6 @@ class PriceType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # dimensional_price_configuration => { - # dimension_values: -> { Orb::ArrayOf[String] === _1 }, - # dimensional_price_group_id: String - # } - # ``` class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # diff --git a/lib/orb/models/price_create_params.rb b/lib/orb/models/price_create_params.rb index 7bf524ca..404119dd 100644 --- a/lib/orb/models/price_create_params.rb +++ b/lib/orb/models/price_create_params.rb @@ -20,7 +20,7 @@ class PriceCreateParams < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -394,12 +394,6 @@ class ModelType < Orb::Enum # def self.values; end end - # @example - # ```ruby - # unit_config => { - # unit_amount: String - # } - # ``` class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -415,13 +409,6 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -473,13 +460,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -531,13 +511,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # package_config => { - # package_amount: String, - # package_size: Integer - # } - # ``` class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -561,14 +534,6 @@ class PackageConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # matrix_config => { - # default_unit_amount: String, - # dimensions: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # matrix_values: -> { Orb::ArrayOf[Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue] === _1 } - # } - # ``` class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -597,13 +562,6 @@ class MatrixConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # matrix_value => { - # dimension_values: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # unit_amount: String - # } - # ``` class MatrixValue < Orb::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -629,15 +587,6 @@ class MatrixValue < Orb::BaseModel end end - # @example - # ```ruby - # matrix_with_allocation_config => { - # allocation: Float, - # default_unit_amount: String, - # dimensions: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # matrix_values: -> { Orb::ArrayOf[Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue] === _1 } - # } - # ``` class MatrixWithAllocationConfig < Orb::BaseModel # @!attribute allocation # Allocation to be used to calculate the price @@ -674,13 +623,6 @@ class MatrixWithAllocationConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # matrix_value => { - # dimension_values: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # unit_amount: String - # } - # ``` class MatrixValue < Orb::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -706,12 +648,6 @@ class MatrixValue < Orb::BaseModel end end - # @example - # ```ruby - # tiered_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::PriceCreateParams::TieredConfig::Tier] === _1 } - # } - # ``` class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -726,14 +662,6 @@ class TieredConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # first_unit: Float, - # unit_amount: String, - # last_unit: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute first_unit # Inclusive tier starting value @@ -764,12 +692,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # tiered_bps_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::PriceCreateParams::TieredBpsConfig::Tier] === _1 } - # } - # ``` class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -785,15 +707,6 @@ class TieredBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # minimum_amount: String, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Per-event basis point rate @@ -831,13 +744,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # bps_config => { - # bps: Float, - # per_unit_maximum: String - # } - # ``` class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -860,12 +766,6 @@ class BpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # bulk_bps_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::PriceCreateParams::BulkBpsConfig::Tier] === _1 } - # } - # ``` class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -881,14 +781,6 @@ class BulkBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Basis points to rate on @@ -919,12 +811,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # bulk_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::PriceCreateParams::BulkConfig::Tier] === _1 } - # } - # ``` class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -939,13 +825,6 @@ class BulkConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # unit_amount: String, - # maximum_units: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute unit_amount # Amount per unit diff --git a/lib/orb/models/price_evaluate_response.rb b/lib/orb/models/price_evaluate_response.rb index 48f1f12e..800a37ed 100644 --- a/lib/orb/models/price_evaluate_response.rb +++ b/lib/orb/models/price_evaluate_response.rb @@ -2,12 +2,6 @@ module Orb module Models - # @example - # ```ruby - # price_evaluate_response => { - # data: -> { Orb::ArrayOf[Orb::Models::EvaluatePriceGroup] === _1 } - # } - # ``` class PriceEvaluateResponse < Orb::BaseModel # @!attribute data # diff --git a/lib/orb/models/subscription.rb b/lib/orb/models/subscription.rb index 80e9595e..dc1e2b38 100644 --- a/lib/orb/models/subscription.rb +++ b/lib/orb/models/subscription.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # subscription => { - # id: String, - # active_plan_phase_order: Integer, - # adjustment_intervals: -> { Orb::ArrayOf[Orb::Models::Subscription::AdjustmentInterval] === _1 }, - # auto_collection: Orb::BooleanModel, - # billing_cycle_anchor_configuration: Orb::Models::Subscription::BillingCycleAnchorConfiguration, - # **_ - # } - # ``` class Subscription < Orb::BaseModel # @!attribute id # @@ -275,16 +264,6 @@ class Subscription < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # adjustment_interval => { - # id: String, - # adjustment: Orb::Models::Subscription::AdjustmentInterval::Adjustment, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # start_date: Time - # } - # ``` class AdjustmentInterval < Orb::BaseModel # @!attribute id # @@ -333,7 +312,7 @@ class AdjustmentInterval < Orb::BaseModel # in { # adjustment_type: "usage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment ... @@ -341,27 +320,27 @@ class AdjustmentInterval < Orb::BaseModel # adjustment_type: "amount_discount", # id: String, # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment ... # in { # adjustment_type: "percentage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment ... # in { # adjustment_type: "minimum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment ... # in { # adjustment_type: "maximum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment ... @@ -401,17 +380,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment } - # @example - # ```ruby - # plan_phase_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # plan_phase_order: Integer, - # **_ - # } - # ``` class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -480,17 +448,6 @@ class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -559,17 +516,6 @@ class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # percentage_discount: Float, - # **_ - # } - # ``` class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -638,17 +584,6 @@ class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # item_id: String, - # **_ - # } - # ``` class PlanPhaseMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -725,17 +660,6 @@ class PlanPhaseMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # maximum_amount: String, - # **_ - # } - # ``` class PlanPhaseMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -806,14 +730,6 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_anchor_configuration => { - # day: Integer, - # month: Integer, - # year: Integer - # } - # ``` class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -857,21 +773,21 @@ class BillingCycleAnchorConfiguration < Orb::BaseModel # in { # discount_type: "amount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval ... # in { # discount_type: "percentage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval ... # in { # discount_type: "usage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval ... @@ -898,16 +814,6 @@ class DiscountInterval < Orb::Union variant :usage, -> { Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval } - # @example - # ```ruby - # amount_discount_interval => { - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :amount, - # end_date: Time - # } - # ``` class AmountDiscountInterval < Orb::BaseModel # @!attribute amount_discount # Only available if discount_type is `amount`. @@ -967,16 +873,6 @@ class AmountDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # percentage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :percentage, - # end_date: Time, - # percentage_discount: Float - # } - # ``` class PercentageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1037,16 +933,6 @@ class PercentageDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # usage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :usage, - # end_date: Time, - # start_date: Time - # } - # ``` class UsageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1108,15 +994,6 @@ class UsageDiscountInterval < Orb::BaseModel end end - # @example - # ```ruby - # fixed_fee_quantity_schedule => { - # end_date: Time, - # price_id: String, - # quantity: Float, - # start_date: Time - # } - # ``` class FixedFeeQuantitySchedule < Orb::BaseModel # @!attribute end_date # @@ -1149,16 +1026,6 @@ class FixedFeeQuantitySchedule < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # maximum_amount: String, - # start_date: Time - # } - # ``` class MaximumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this maximum interval applies to. @@ -1203,16 +1070,6 @@ class MaximumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # minimum_amount: String, - # start_date: Time - # } - # ``` class MinimumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this minimum interval applies to. @@ -1257,17 +1114,6 @@ class MinimumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # price_interval => { - # id: String, - # billing_cycle_day: Integer, - # current_billing_period_end_date: Time, - # current_billing_period_start_date: Time, - # end_date: Time, - # **_ - # } - # ``` class PriceInterval < Orb::BaseModel # @!attribute id # @@ -1364,14 +1210,6 @@ class PriceInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # fixed_fee_quantity_transition => { - # effective_date: Time, - # price_id: String, - # quantity: Integer - # } - # ``` class FixedFeeQuantityTransition < Orb::BaseModel # @!attribute effective_date # @@ -1399,14 +1237,6 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end - # @example - # ```ruby - # redeemed_coupon => { - # coupon_id: String, - # end_date: Time, - # start_date: Time - # } - # ``` class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1459,12 +1289,6 @@ class Status < Orb::Enum # def self.values; end end - # @example - # ```ruby - # trial_info => { - # end_date: Time - # } - # ``` class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_cancel_response.rb b/lib/orb/models/subscription_cancel_response.rb index ffa699d9..dd57e5e5 100644 --- a/lib/orb/models/subscription_cancel_response.rb +++ b/lib/orb/models/subscription_cancel_response.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # subscription_cancel_response => { - # id: String, - # active_plan_phase_order: Integer, - # adjustment_intervals: -> { Orb::ArrayOf[Orb::Models::SubscriptionCancelResponse::AdjustmentInterval] === _1 }, - # auto_collection: Orb::BooleanModel, - # billing_cycle_anchor_configuration: Orb::Models::SubscriptionCancelResponse::BillingCycleAnchorConfiguration, - # **_ - # } - # ``` class SubscriptionCancelResponse < Orb::BaseModel # @!attribute id # @@ -257,16 +246,6 @@ class SubscriptionCancelResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # adjustment_interval => { - # id: String, - # adjustment: Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # start_date: Time - # } - # ``` class AdjustmentInterval < Orb::BaseModel # @!attribute id # @@ -316,7 +295,7 @@ class AdjustmentInterval < Orb::BaseModel # in { # adjustment_type: "usage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment ... @@ -324,27 +303,27 @@ class AdjustmentInterval < Orb::BaseModel # adjustment_type: "amount_discount", # id: String, # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment ... # in { # adjustment_type: "percentage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment ... # in { # adjustment_type: "minimum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment ... # in { # adjustment_type: "maximum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment ... @@ -384,17 +363,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment } - # @example - # ```ruby - # plan_phase_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # plan_phase_order: Integer, - # **_ - # } - # ``` class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -463,17 +431,6 @@ class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -542,17 +499,6 @@ class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # percentage_discount: Float, - # **_ - # } - # ``` class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -621,17 +567,6 @@ class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # item_id: String, - # **_ - # } - # ``` class PlanPhaseMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -708,17 +643,6 @@ class PlanPhaseMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # maximum_amount: String, - # **_ - # } - # ``` class PlanPhaseMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -789,14 +713,6 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_anchor_configuration => { - # day: Integer, - # month: Integer, - # year: Integer - # } - # ``` class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -840,21 +756,21 @@ class BillingCycleAnchorConfiguration < Orb::BaseModel # in { # discount_type: "amount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionCancelResponse::DiscountInterval::AmountDiscountInterval ... # in { # discount_type: "percentage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval ... # in { # discount_type: "usage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval ... @@ -882,16 +798,6 @@ class DiscountInterval < Orb::Union variant :usage, -> { Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval } - # @example - # ```ruby - # amount_discount_interval => { - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :amount, - # end_date: Time - # } - # ``` class AmountDiscountInterval < Orb::BaseModel # @!attribute amount_discount # Only available if discount_type is `amount`. @@ -951,16 +857,6 @@ class AmountDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # percentage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :percentage, - # end_date: Time, - # percentage_discount: Float - # } - # ``` class PercentageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1021,16 +917,6 @@ class PercentageDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # usage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :usage, - # end_date: Time, - # start_date: Time - # } - # ``` class UsageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1092,15 +978,6 @@ class UsageDiscountInterval < Orb::BaseModel end end - # @example - # ```ruby - # fixed_fee_quantity_schedule => { - # end_date: Time, - # price_id: String, - # quantity: Float, - # start_date: Time - # } - # ``` class FixedFeeQuantitySchedule < Orb::BaseModel # @!attribute end_date # @@ -1133,16 +1010,6 @@ class FixedFeeQuantitySchedule < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # maximum_amount: String, - # start_date: Time - # } - # ``` class MaximumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this maximum interval applies to. @@ -1187,16 +1054,6 @@ class MaximumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # minimum_amount: String, - # start_date: Time - # } - # ``` class MinimumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this minimum interval applies to. @@ -1241,17 +1098,6 @@ class MinimumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # price_interval => { - # id: String, - # billing_cycle_day: Integer, - # current_billing_period_end_date: Time, - # current_billing_period_start_date: Time, - # end_date: Time, - # **_ - # } - # ``` class PriceInterval < Orb::BaseModel # @!attribute id # @@ -1348,14 +1194,6 @@ class PriceInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # fixed_fee_quantity_transition => { - # effective_date: Time, - # price_id: String, - # quantity: Integer - # } - # ``` class FixedFeeQuantityTransition < Orb::BaseModel # @!attribute effective_date # @@ -1383,14 +1221,6 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end - # @example - # ```ruby - # redeemed_coupon => { - # coupon_id: String, - # end_date: Time, - # start_date: Time - # } - # ``` class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1443,12 +1273,6 @@ class Status < Orb::Enum # def self.values; end end - # @example - # ```ruby - # trial_info => { - # end_date: Time - # } - # ``` class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_create_params.rb b/lib/orb/models/subscription_create_params.rb index 120f394d..e25acd30 100644 --- a/lib/orb/models/subscription_create_params.rb +++ b/lib/orb/models/subscription_create_params.rb @@ -292,15 +292,6 @@ class SubscriptionCreateParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # add_adjustment => { - # adjustment: Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment, - # end_date: Time, - # plan_phase_order: Integer, - # start_date: Time - # } - # ``` class AddAdjustment < Orb::BaseModel # @!attribute adjustment # The definition of a new adjustment to create and add to the subscription. @@ -348,14 +339,14 @@ class AddAdjustment < Orb::BaseModel # case adjustment # in { # adjustment_type: "percentage_discount", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # percentage_discount: Float, # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewPercentageDiscount ... # in { # adjustment_type: "usage_discount", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # usage_discount: Float, # is_invoice_level: Orb::BooleanModel # } @@ -363,20 +354,20 @@ class AddAdjustment < Orb::BaseModel # in { # adjustment_type: "amount_discount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewAmountDiscount ... # in { # adjustment_type: "minimum", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # item_id: String, # minimum_amount: String # } # # Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewMinimum ... # in { # adjustment_type: "maximum", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # maximum_amount: String, # is_invoice_level: Orb::BooleanModel # } @@ -415,15 +406,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewMaximum } - # @example - # ```ruby - # new_percentage_discount => { - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # percentage_discount: Float, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewPercentageDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -471,15 +453,6 @@ class NewPercentageDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_usage_discount => { - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # usage_discount: Float, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewUsageDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -519,15 +492,6 @@ class NewUsageDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_amount_discount => { - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewAmountDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -567,16 +531,6 @@ class NewAmountDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_minimum => { - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # item_id: String, - # minimum_amount: String, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewMinimum < Orb::BaseModel # @!attribute adjustment_type # @@ -623,15 +577,6 @@ class NewMinimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_maximum => { - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewMaximum < Orb::BaseModel # @!attribute adjustment_type # @@ -673,17 +618,6 @@ class NewMaximum < Orb::BaseModel end end - # @example - # ```ruby - # add_price => { - # allocation_price: Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice, - # discounts: -> { Orb::ArrayOf[Orb::Models::SubscriptionCreateParams::AddPrice::Discount] === _1 }, - # end_date: Time, - # external_price_id: String, - # maximum_amount: String, - # **_ - # } - # ``` class AddPrice < Orb::BaseModel # @!attribute allocation_price # The definition of a new allocation price to create and add to the subscription. @@ -786,15 +720,6 @@ class AddPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # allocation_price => { - # amount: String, - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::Cadence, - # currency: String, - # expires_at_end_of_cadence: Orb::BooleanModel - # } - # ``` class AllocationPrice < Orb::BaseModel # @!attribute amount # An amount of the currency to allocate to the customer at the specified cadence. @@ -872,15 +797,6 @@ class Cadence < Orb::Enum end end - # @example - # ```ruby - # discount => { - # discount_type: Orb::Models::SubscriptionCreateParams::AddPrice::Discount::DiscountType, - # amount_discount: String, - # percentage_discount: Float, - # usage_discount: Float - # } - # ``` class Discount < Orb::BaseModel # @!attribute discount_type # @@ -1060,20 +976,20 @@ class DiscountType < Orb::Enum # in { # model_type: "grouped_allocation", # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence, - # grouped_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # grouped_allocation_config: ^(Orb::HashOf[Orb::Unknown]), # item_id: String # } # # Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice ... # in { # model_type: "grouped_with_prorated_minimum", # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence, - # grouped_with_prorated_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # grouped_with_prorated_minimum_config: ^(Orb::HashOf[Orb::Unknown]), # item_id: String # } # # Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice ... # in { # model_type: "bulk_with_proration", - # bulk_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # bulk_with_proration_config: ^(Orb::HashOf[Orb::Unknown]), # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence, # item_id: String # } @@ -1174,17 +1090,6 @@ class Price < Orb::Union variant :bulk_with_proration, -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice } - # @example - # ```ruby - # new_subscription_unit_price => { - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence, - # item_id: String, - # model_type: :unit, - # name: String, - # unit_config: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::UnitConfig, - # **_ - # } - # ``` class NewSubscriptionUnitPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -1194,7 +1099,7 @@ class NewSubscriptionUnitPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -1374,12 +1279,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # unit_config => { - # unit_amount: String - # } - # ``` class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -1395,13 +1294,6 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1453,13 +1345,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1512,17 +1397,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_package_price => { - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence, - # item_id: String, - # model_type: :package, - # name: String, - # package_config: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::PackageConfig, - # **_ - # } - # ``` class NewSubscriptionPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -1532,7 +1406,7 @@ class NewSubscriptionPackagePrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -1712,13 +1586,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # package_config => { - # package_amount: String, - # package_size: Integer - # } - # ``` class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -1742,13 +1609,6 @@ class PackageConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1800,13 +1660,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1859,17 +1712,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_matrix_price => { - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence, - # item_id: String, - # matrix_config: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig, - # model_type: :matrix, - # name: String, - # **_ - # } - # ``` class NewSubscriptionMatrixPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -1879,7 +1721,7 @@ class NewSubscriptionMatrixPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -2059,18 +1901,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # matrix_config => { - # default_unit_amount: String, - # dimensions: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # matrix_values: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue - # ] === _1 - # end - # } - # ``` class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -2104,13 +1934,6 @@ class MatrixConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # matrix_value => { - # dimension_values: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # unit_amount: String - # } - # ``` class MatrixValue < Orb::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -2136,13 +1959,6 @@ class MatrixValue < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2194,13 +2010,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2253,17 +2062,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_price => { - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence, - # item_id: String, - # model_type: :tiered, - # name: String, - # tiered_config: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig, - # **_ - # } - # ``` class NewSubscriptionTieredPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -2273,7 +2071,7 @@ class NewSubscriptionTieredPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -2453,12 +2251,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # tiered_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier] === _1 } - # } - # ``` class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -2474,14 +2266,6 @@ class TieredConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # first_unit: Float, - # unit_amount: String, - # last_unit: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute first_unit # Inclusive tier starting value @@ -2512,13 +2296,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2570,13 +2347,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2629,17 +2399,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_bps_price => { - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence, - # item_id: String, - # model_type: :tiered_bps, - # name: String, - # tiered_bps_config: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig, - # **_ - # } - # ``` class NewSubscriptionTieredBpsPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -2649,7 +2408,7 @@ class NewSubscriptionTieredBpsPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -2829,16 +2588,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # tiered_bps_config => { - # tiers: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier - # ] === _1 - # end - # } - # ``` class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -2859,15 +2608,6 @@ class TieredBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # minimum_amount: String, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Per-event basis point rate @@ -2905,13 +2645,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2963,13 +2696,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3022,17 +2748,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bps_price => { - # bps_config: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BpsConfig, - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence, - # item_id: String, - # model_type: :bps, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBpsPrice < Orb::BaseModel # @!attribute bps_config # @@ -3048,7 +2763,7 @@ class NewSubscriptionBpsPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -3185,13 +2900,6 @@ class NewSubscriptionBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bps_config => { - # bps: Float, - # per_unit_maximum: String - # } - # ``` class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -3251,13 +2959,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3309,13 +3010,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3368,17 +3062,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bulk_bps_price => { - # bulk_bps_config: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig, - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence, - # item_id: String, - # model_type: :bulk_bps, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBulkBpsPrice < Orb::BaseModel # @!attribute bulk_bps_config # @@ -3394,7 +3077,7 @@ class NewSubscriptionBulkBpsPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -3531,12 +3214,6 @@ class NewSubscriptionBulkBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bulk_bps_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier] === _1 } - # } - # ``` class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -3553,14 +3230,6 @@ class BulkBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Basis points to rate on @@ -3628,13 +3297,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3686,13 +3348,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3745,17 +3400,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bulk_price => { - # bulk_config: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig, - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence, - # item_id: String, - # model_type: :bulk, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBulkPrice < Orb::BaseModel # @!attribute bulk_config # @@ -3771,7 +3415,7 @@ class NewSubscriptionBulkPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -3908,12 +3552,6 @@ class NewSubscriptionBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bulk_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier] === _1 } - # } - # ``` class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -3929,13 +3567,6 @@ class BulkConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # unit_amount: String, - # maximum_units: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute unit_amount # Amount per unit @@ -3996,13 +3627,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4054,13 +3678,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4113,17 +3730,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_threshold_total_amount_price => { - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence, - # item_id: String, - # model_type: :threshold_total_amount, - # name: String, - # threshold_total_amount_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionThresholdTotalAmountPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -4133,7 +3739,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -4312,13 +3918,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4370,13 +3969,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4429,17 +4021,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_package_price => { - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence, - # item_id: String, - # model_type: :tiered_package, - # name: String, - # tiered_package_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionTieredPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -4449,7 +4030,7 @@ class NewSubscriptionTieredPackagePrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -4628,13 +4209,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4686,13 +4260,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4745,17 +4312,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_with_minimum_price => { - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence, - # item_id: String, - # model_type: :tiered_with_minimum, - # name: String, - # tiered_with_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionTieredWithMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -4765,7 +4321,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -4944,13 +4500,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5002,13 +4551,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5061,17 +4603,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_unit_with_percent_price => { - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence, - # item_id: String, - # model_type: :unit_with_percent, - # name: String, - # unit_with_percent_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionUnitWithPercentPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -5081,7 +4612,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -5260,13 +4791,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5318,13 +4842,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5377,17 +4894,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_package_with_allocation_price => { - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence, - # item_id: String, - # model_type: :package_with_allocation, - # name: String, - # package_with_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionPackageWithAllocationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -5397,7 +4903,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -5576,13 +5082,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5634,13 +5133,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5693,17 +5185,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tier_with_proration_price => { - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence, - # item_id: String, - # model_type: :tiered_with_proration, - # name: String, - # tiered_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionTierWithProrationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -5713,7 +5194,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -5892,13 +5373,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5950,13 +5424,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6009,17 +5476,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_unit_with_proration_price => { - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence, - # item_id: String, - # model_type: :unit_with_proration, - # name: String, - # unit_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionUnitWithProrationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -6029,7 +5485,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -6208,13 +5664,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6266,13 +5715,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6325,17 +5767,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_grouped_allocation_price => { - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence, - # grouped_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_allocation, - # name: String, - # **_ - # } - # ``` class NewSubscriptionGroupedAllocationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -6350,7 +5781,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::BaseModel required :grouped_allocation_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -6524,13 +5955,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6582,13 +6006,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6641,17 +6058,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_grouped_with_prorated_minimum_price => { - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence, - # grouped_with_prorated_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_with_prorated_minimum, - # name: String, - # **_ - # } - # ``` class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -6666,7 +6072,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::BaseModel required :grouped_with_prorated_minimum_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -6840,13 +6246,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6898,13 +6297,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6957,17 +6349,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bulk_with_proration_price => { - # bulk_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # cadence: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence, - # item_id: String, - # model_type: :bulk_with_proration, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBulkWithProrationPrice < Orb::BaseModel # @!attribute bulk_with_proration_config # @@ -6982,7 +6363,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -7156,13 +6537,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7214,13 +6588,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7275,14 +6642,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # billing_cycle_anchor_configuration => { - # day: Integer, - # month: Integer, - # year: Integer - # } - # ``` class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -7346,12 +6705,6 @@ class ExternalMarketplace < Orb::Enum # def self.values; end end - # @example - # ```ruby - # remove_adjustment => { - # adjustment_id: String - # } - # ``` class RemoveAdjustment < Orb::BaseModel # @!attribute adjustment_id # The id of the adjustment to remove on the subscription. @@ -7367,13 +6720,6 @@ class RemoveAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # remove_price => { - # external_price_id: String, - # price_id: String - # } - # ``` class RemovePrice < Orb::BaseModel # @!attribute external_price_id # The external price id of the price to remove on the subscription. @@ -7396,13 +6742,6 @@ class RemovePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # replace_adjustment => { - # adjustment: Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment, - # replaces_adjustment_id: String - # } - # ``` class ReplaceAdjustment < Orb::BaseModel # @!attribute adjustment # The definition of a new adjustment to create and add to the subscription. @@ -7433,14 +6772,14 @@ class ReplaceAdjustment < Orb::BaseModel # case adjustment # in { # adjustment_type: "percentage_discount", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # percentage_discount: Float, # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewPercentageDiscount ... # in { # adjustment_type: "usage_discount", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # usage_discount: Float, # is_invoice_level: Orb::BooleanModel # } @@ -7448,20 +6787,20 @@ class ReplaceAdjustment < Orb::BaseModel # in { # adjustment_type: "amount_discount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewAmountDiscount ... # in { # adjustment_type: "minimum", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # item_id: String, # minimum_amount: String # } # # Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewMinimum ... # in { # adjustment_type: "maximum", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # maximum_amount: String, # is_invoice_level: Orb::BooleanModel # } @@ -7500,15 +6839,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewMaximum } - # @example - # ```ruby - # new_percentage_discount => { - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # percentage_discount: Float, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewPercentageDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -7556,15 +6886,6 @@ class NewPercentageDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_usage_discount => { - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # usage_discount: Float, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewUsageDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -7604,15 +6925,6 @@ class NewUsageDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_amount_discount => { - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewAmountDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -7652,16 +6964,6 @@ class NewAmountDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_minimum => { - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # item_id: String, - # minimum_amount: String, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewMinimum < Orb::BaseModel # @!attribute adjustment_type # @@ -7708,15 +7010,6 @@ class NewMinimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_maximum => { - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewMaximum < Orb::BaseModel # @!attribute adjustment_type # @@ -7758,17 +7051,6 @@ class NewMaximum < Orb::BaseModel end end - # @example - # ```ruby - # replace_price => { - # replaces_price_id: String, - # allocation_price: Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice, - # discounts: -> { Orb::ArrayOf[Orb::Models::SubscriptionCreateParams::ReplacePrice::Discount] === _1 }, - # external_price_id: String, - # fixed_price_quantity: Float, - # **_ - # } - # ``` class ReplacePrice < Orb::BaseModel # @!attribute replaces_price_id # The id of the price on the plan to replace in the subscription. @@ -7859,15 +7141,6 @@ class ReplacePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # allocation_price => { - # amount: String, - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice::Cadence, - # currency: String, - # expires_at_end_of_cadence: Orb::BooleanModel - # } - # ``` class AllocationPrice < Orb::BaseModel # @!attribute amount # An amount of the currency to allocate to the customer at the specified cadence. @@ -7946,15 +7219,6 @@ class Cadence < Orb::Enum end end - # @example - # ```ruby - # discount => { - # discount_type: Orb::Models::SubscriptionCreateParams::ReplacePrice::Discount::DiscountType, - # amount_discount: String, - # percentage_discount: Float, - # usage_discount: Float - # } - # ``` class Discount < Orb::BaseModel # @!attribute discount_type # @@ -8134,20 +7398,20 @@ class DiscountType < Orb::Enum # in { # model_type: "grouped_allocation", # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence, - # grouped_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # grouped_allocation_config: ^(Orb::HashOf[Orb::Unknown]), # item_id: String # } # # Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice ... # in { # model_type: "grouped_with_prorated_minimum", # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence, - # grouped_with_prorated_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # grouped_with_prorated_minimum_config: ^(Orb::HashOf[Orb::Unknown]), # item_id: String # } # # Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice ... # in { # model_type: "bulk_with_proration", - # bulk_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # bulk_with_proration_config: ^(Orb::HashOf[Orb::Unknown]), # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence, # item_id: String # } @@ -8250,17 +7514,6 @@ class Price < Orb::Union variant :bulk_with_proration, -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice } - # @example - # ```ruby - # new_subscription_unit_price => { - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence, - # item_id: String, - # model_type: :unit, - # name: String, - # unit_config: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::UnitConfig, - # **_ - # } - # ``` class NewSubscriptionUnitPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -8270,7 +7523,7 @@ class NewSubscriptionUnitPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -8450,12 +7703,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # unit_config => { - # unit_amount: String - # } - # ``` class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -8471,13 +7718,6 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8529,13 +7769,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8588,17 +7821,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_package_price => { - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence, - # item_id: String, - # model_type: :package, - # name: String, - # package_config: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::PackageConfig, - # **_ - # } - # ``` class NewSubscriptionPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -8608,7 +7830,7 @@ class NewSubscriptionPackagePrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -8788,13 +8010,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # package_config => { - # package_amount: String, - # package_size: Integer - # } - # ``` class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -8818,13 +8033,6 @@ class PackageConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8876,13 +8084,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8935,17 +8136,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_matrix_price => { - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence, - # item_id: String, - # matrix_config: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig, - # model_type: :matrix, - # name: String, - # **_ - # } - # ``` class NewSubscriptionMatrixPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -8955,7 +8145,7 @@ class NewSubscriptionMatrixPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -9135,18 +8325,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # matrix_config => { - # default_unit_amount: String, - # dimensions: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # matrix_values: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue - # ] === _1 - # end - # } - # ``` class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -9180,13 +8358,6 @@ class MatrixConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # matrix_value => { - # dimension_values: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # unit_amount: String - # } - # ``` class MatrixValue < Orb::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -9212,13 +8383,6 @@ class MatrixValue < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9270,13 +8434,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9329,17 +8486,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_price => { - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence, - # item_id: String, - # model_type: :tiered, - # name: String, - # tiered_config: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig, - # **_ - # } - # ``` class NewSubscriptionTieredPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -9349,7 +8495,7 @@ class NewSubscriptionTieredPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -9529,12 +8675,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # tiered_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier] === _1 } - # } - # ``` class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -9550,14 +8690,6 @@ class TieredConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # first_unit: Float, - # unit_amount: String, - # last_unit: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute first_unit # Inclusive tier starting value @@ -9588,13 +8720,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9646,13 +8771,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9705,17 +8823,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_bps_price => { - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence, - # item_id: String, - # model_type: :tiered_bps, - # name: String, - # tiered_bps_config: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig, - # **_ - # } - # ``` class NewSubscriptionTieredBpsPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -9725,7 +8832,7 @@ class NewSubscriptionTieredBpsPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -9905,16 +9012,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # tiered_bps_config => { - # tiers: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier - # ] === _1 - # end - # } - # ``` class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -9935,15 +9032,6 @@ class TieredBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # minimum_amount: String, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Per-event basis point rate @@ -9981,13 +9069,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10039,13 +9120,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10098,17 +9172,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bps_price => { - # bps_config: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BpsConfig, - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence, - # item_id: String, - # model_type: :bps, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBpsPrice < Orb::BaseModel # @!attribute bps_config # @@ -10124,7 +9187,7 @@ class NewSubscriptionBpsPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -10261,13 +9324,6 @@ class NewSubscriptionBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bps_config => { - # bps: Float, - # per_unit_maximum: String - # } - # ``` class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -10327,13 +9383,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10385,13 +9434,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10444,17 +9486,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bulk_bps_price => { - # bulk_bps_config: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig, - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence, - # item_id: String, - # model_type: :bulk_bps, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBulkBpsPrice < Orb::BaseModel # @!attribute bulk_bps_config # @@ -10470,7 +9501,7 @@ class NewSubscriptionBulkBpsPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -10607,16 +9638,6 @@ class NewSubscriptionBulkBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bulk_bps_config => { - # tiers: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier - # ] === _1 - # end - # } - # ``` class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -10637,14 +9658,6 @@ class BulkBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Basis points to rate on @@ -10712,13 +9725,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10770,13 +9776,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10829,17 +9828,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bulk_price => { - # bulk_config: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig, - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence, - # item_id: String, - # model_type: :bulk, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBulkPrice < Orb::BaseModel # @!attribute bulk_config # @@ -10855,7 +9843,7 @@ class NewSubscriptionBulkPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -10992,12 +9980,6 @@ class NewSubscriptionBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bulk_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier] === _1 } - # } - # ``` class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -11013,13 +9995,6 @@ class BulkConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # unit_amount: String, - # maximum_units: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute unit_amount # Amount per unit @@ -11080,13 +10055,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11138,13 +10106,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11197,17 +10158,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_threshold_total_amount_price => { - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence, - # item_id: String, - # model_type: :threshold_total_amount, - # name: String, - # threshold_total_amount_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionThresholdTotalAmountPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -11217,7 +10167,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -11396,13 +10346,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11454,13 +10397,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11513,17 +10449,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_package_price => { - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence, - # item_id: String, - # model_type: :tiered_package, - # name: String, - # tiered_package_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionTieredPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -11533,7 +10458,7 @@ class NewSubscriptionTieredPackagePrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -11712,13 +10637,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11770,13 +10688,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11829,17 +10740,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_with_minimum_price => { - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence, - # item_id: String, - # model_type: :tiered_with_minimum, - # name: String, - # tiered_with_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionTieredWithMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -11849,7 +10749,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -12028,13 +10928,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12086,13 +10979,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12145,17 +11031,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_unit_with_percent_price => { - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence, - # item_id: String, - # model_type: :unit_with_percent, - # name: String, - # unit_with_percent_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionUnitWithPercentPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -12165,7 +11040,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -12344,13 +11219,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12402,13 +11270,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12461,17 +11322,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_package_with_allocation_price => { - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence, - # item_id: String, - # model_type: :package_with_allocation, - # name: String, - # package_with_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionPackageWithAllocationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -12481,7 +11331,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -12660,13 +11510,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12718,13 +11561,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12777,17 +11613,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tier_with_proration_price => { - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence, - # item_id: String, - # model_type: :tiered_with_proration, - # name: String, - # tiered_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionTierWithProrationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -12797,7 +11622,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -12976,13 +11801,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13034,13 +11852,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13093,17 +11904,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_unit_with_proration_price => { - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence, - # item_id: String, - # model_type: :unit_with_proration, - # name: String, - # unit_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionUnitWithProrationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -13113,7 +11913,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -13292,13 +12092,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13350,13 +12143,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13409,17 +12195,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_grouped_allocation_price => { - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence, - # grouped_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_allocation, - # name: String, - # **_ - # } - # ``` class NewSubscriptionGroupedAllocationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -13434,7 +12209,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::BaseModel required :grouped_allocation_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -13608,13 +12383,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13666,13 +12434,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13725,17 +12486,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_grouped_with_prorated_minimum_price => { - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence, - # grouped_with_prorated_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_with_prorated_minimum, - # name: String, - # **_ - # } - # ``` class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -13750,7 +12500,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::BaseModel required :grouped_with_prorated_minimum_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -13924,13 +12674,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13982,13 +12725,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14041,17 +12777,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bulk_with_proration_price => { - # bulk_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # cadence: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence, - # item_id: String, - # model_type: :bulk_with_proration, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBulkWithProrationPrice < Orb::BaseModel # @!attribute bulk_with_proration_config # @@ -14066,7 +12791,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -14240,13 +12965,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14298,13 +13016,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. diff --git a/lib/orb/models/subscription_create_response.rb b/lib/orb/models/subscription_create_response.rb index c17b5253..36800ce5 100644 --- a/lib/orb/models/subscription_create_response.rb +++ b/lib/orb/models/subscription_create_response.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # subscription_create_response => { - # id: String, - # active_plan_phase_order: Integer, - # adjustment_intervals: -> { Orb::ArrayOf[Orb::Models::SubscriptionCreateResponse::AdjustmentInterval] === _1 }, - # auto_collection: Orb::BooleanModel, - # billing_cycle_anchor_configuration: Orb::Models::SubscriptionCreateResponse::BillingCycleAnchorConfiguration, - # **_ - # } - # ``` class SubscriptionCreateResponse < Orb::BaseModel # @!attribute id # @@ -257,16 +246,6 @@ class SubscriptionCreateResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # adjustment_interval => { - # id: String, - # adjustment: Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # start_date: Time - # } - # ``` class AdjustmentInterval < Orb::BaseModel # @!attribute id # @@ -316,7 +295,7 @@ class AdjustmentInterval < Orb::BaseModel # in { # adjustment_type: "usage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment ... @@ -324,27 +303,27 @@ class AdjustmentInterval < Orb::BaseModel # adjustment_type: "amount_discount", # id: String, # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment ... # in { # adjustment_type: "percentage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment ... # in { # adjustment_type: "minimum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment ... # in { # adjustment_type: "maximum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment ... @@ -384,17 +363,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment } - # @example - # ```ruby - # plan_phase_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # plan_phase_order: Integer, - # **_ - # } - # ``` class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -463,17 +431,6 @@ class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -542,17 +499,6 @@ class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # percentage_discount: Float, - # **_ - # } - # ``` class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -621,17 +567,6 @@ class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # item_id: String, - # **_ - # } - # ``` class PlanPhaseMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -708,17 +643,6 @@ class PlanPhaseMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # maximum_amount: String, - # **_ - # } - # ``` class PlanPhaseMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -789,14 +713,6 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_anchor_configuration => { - # day: Integer, - # month: Integer, - # year: Integer - # } - # ``` class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -840,21 +756,21 @@ class BillingCycleAnchorConfiguration < Orb::BaseModel # in { # discount_type: "amount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval ... # in { # discount_type: "percentage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval ... # in { # discount_type: "usage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval ... @@ -882,16 +798,6 @@ class DiscountInterval < Orb::Union variant :usage, -> { Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval } - # @example - # ```ruby - # amount_discount_interval => { - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :amount, - # end_date: Time - # } - # ``` class AmountDiscountInterval < Orb::BaseModel # @!attribute amount_discount # Only available if discount_type is `amount`. @@ -951,16 +857,6 @@ class AmountDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # percentage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :percentage, - # end_date: Time, - # percentage_discount: Float - # } - # ``` class PercentageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1021,16 +917,6 @@ class PercentageDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # usage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :usage, - # end_date: Time, - # start_date: Time - # } - # ``` class UsageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1092,15 +978,6 @@ class UsageDiscountInterval < Orb::BaseModel end end - # @example - # ```ruby - # fixed_fee_quantity_schedule => { - # end_date: Time, - # price_id: String, - # quantity: Float, - # start_date: Time - # } - # ``` class FixedFeeQuantitySchedule < Orb::BaseModel # @!attribute end_date # @@ -1133,16 +1010,6 @@ class FixedFeeQuantitySchedule < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # maximum_amount: String, - # start_date: Time - # } - # ``` class MaximumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this maximum interval applies to. @@ -1187,16 +1054,6 @@ class MaximumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # minimum_amount: String, - # start_date: Time - # } - # ``` class MinimumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this minimum interval applies to. @@ -1241,17 +1098,6 @@ class MinimumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # price_interval => { - # id: String, - # billing_cycle_day: Integer, - # current_billing_period_end_date: Time, - # current_billing_period_start_date: Time, - # end_date: Time, - # **_ - # } - # ``` class PriceInterval < Orb::BaseModel # @!attribute id # @@ -1348,14 +1194,6 @@ class PriceInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # fixed_fee_quantity_transition => { - # effective_date: Time, - # price_id: String, - # quantity: Integer - # } - # ``` class FixedFeeQuantityTransition < Orb::BaseModel # @!attribute effective_date # @@ -1383,14 +1221,6 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end - # @example - # ```ruby - # redeemed_coupon => { - # coupon_id: String, - # end_date: Time, - # start_date: Time - # } - # ``` class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1443,12 +1273,6 @@ class Status < Orb::Enum # def self.values; end end - # @example - # ```ruby - # trial_info => { - # end_date: Time - # } - # ``` class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_fetch_costs_response.rb b/lib/orb/models/subscription_fetch_costs_response.rb index 82204ccb..9ed47e19 100644 --- a/lib/orb/models/subscription_fetch_costs_response.rb +++ b/lib/orb/models/subscription_fetch_costs_response.rb @@ -2,12 +2,6 @@ module Orb module Models - # @example - # ```ruby - # subscription_fetch_costs_response => { - # data: -> { Orb::ArrayOf[Orb::Models::SubscriptionFetchCostsResponse::Data] === _1 } - # } - # ``` class SubscriptionFetchCostsResponse < Orb::BaseModel # @!attribute data # @@ -21,16 +15,6 @@ class SubscriptionFetchCostsResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # data => { - # per_price_costs: -> { Orb::ArrayOf[Orb::Models::SubscriptionFetchCostsResponse::Data::PerPriceCost] === _1 }, - # subtotal: String, - # timeframe_end: Time, - # timeframe_start: Time, - # total: String - # } - # ``` class Data < Orb::BaseModel # @!attribute per_price_costs # @@ -71,16 +55,6 @@ class Data < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # per_price_cost => { - # price: Orb::Models::Price, - # price_id: String, - # subtotal: String, - # total: String, - # quantity: Float - # } - # ``` class PerPriceCost < Orb::BaseModel # @!attribute price # The price object diff --git a/lib/orb/models/subscription_fetch_schedule_response.rb b/lib/orb/models/subscription_fetch_schedule_response.rb index 84ab2b05..38ccc9d7 100644 --- a/lib/orb/models/subscription_fetch_schedule_response.rb +++ b/lib/orb/models/subscription_fetch_schedule_response.rb @@ -2,15 +2,6 @@ module Orb module Models - # @example - # ```ruby - # subscription_fetch_schedule_response => { - # created_at: Time, - # end_date: Time, - # plan: Orb::Models::SubscriptionFetchScheduleResponse::Plan, - # start_date: Time - # } - # ``` class SubscriptionFetchScheduleResponse < Orb::BaseModel # @!attribute created_at # @@ -42,14 +33,6 @@ class SubscriptionFetchScheduleResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # plan => { - # id: String, - # external_plan_id: String, - # name: String - # } - # ``` class Plan < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/subscription_price_intervals_params.rb b/lib/orb/models/subscription_price_intervals_params.rb index 5bf1d21a..5398c16e 100644 --- a/lib/orb/models/subscription_price_intervals_params.rb +++ b/lib/orb/models/subscription_price_intervals_params.rb @@ -79,17 +79,6 @@ class SubscriptionPriceIntervalsParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # add => { - # start_date: Orb::Models::SubscriptionPriceIntervalsParams::Add::StartDate, - # allocation_price: Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice, - # discounts: -> { Orb::ArrayOf[union: Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount] === _1 }, - # end_date: Orb::Models::SubscriptionPriceIntervalsParams::Add::EndDate, - # external_price_id: String, - # **_ - # } - # ``` class Add < Orb::BaseModel # @!attribute start_date # The start date of the price interval. This is the date that the price will start @@ -211,15 +200,6 @@ class StartDate < Orb::Union variant enum: -> { Orb::Models::BillingCycleRelativeDate } end - # @example - # ```ruby - # allocation_price => { - # amount: String, - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence, - # currency: String, - # expires_at_end_of_cadence: Orb::BooleanModel - # } - # ``` class AllocationPrice < Orb::BaseModel # @!attribute amount # An amount of the currency to allocate to the customer at the specified cadence. @@ -335,13 +315,6 @@ class Discount < Orb::Union variant :usage, -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::UsageDiscountCreationParams } - # @example - # ```ruby - # amount_discount_creation_params => { - # amount_discount: Float, - # discount_type: :amount - # } - # ``` class AmountDiscountCreationParams < Orb::BaseModel # @!attribute amount_discount # Only available if discount_type is `amount`. @@ -363,13 +336,6 @@ class AmountDiscountCreationParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # percentage_discount_creation_params => { - # discount_type: :percentage, - # percentage_discount: Float - # } - # ``` class PercentageDiscountCreationParams < Orb::BaseModel # @!attribute discount_type # @@ -392,13 +358,6 @@ class PercentageDiscountCreationParams < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # usage_discount_creation_params => { - # discount_type: :usage, - # usage_discount: Float - # } - # ``` class UsageDiscountCreationParams < Orb::BaseModel # @!attribute discount_type # @@ -442,13 +401,6 @@ class EndDate < Orb::Union variant enum: -> { Orb::Models::BillingCycleRelativeDate } end - # @example - # ```ruby - # fixed_fee_quantity_transition => { - # effective_date: Time, - # quantity: Integer - # } - # ``` class FixedFeeQuantityTransition < Orb::BaseModel # @!attribute effective_date # The date that the fixed fee quantity transition should take effect. @@ -559,7 +511,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel # model_type: "grouped_tiered", # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::Cadence, # currency: String, - # grouped_tiered_config: -> { Orb::HashOf[Orb::Unknown] === _1 } + # grouped_tiered_config: ^(Orb::HashOf[Orb::Unknown]) # } # # Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice ... # in { @@ -615,21 +567,21 @@ class FixedFeeQuantityTransition < Orb::BaseModel # model_type: "grouped_allocation", # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::Cadence, # currency: String, - # grouped_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 } + # grouped_allocation_config: ^(Orb::HashOf[Orb::Unknown]) # } # # Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice ... # in { # model_type: "grouped_with_prorated_minimum", # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::Cadence, # currency: String, - # grouped_with_prorated_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 } + # grouped_with_prorated_minimum_config: ^(Orb::HashOf[Orb::Unknown]) # } # # Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice ... # in { # model_type: "grouped_with_metered_minimum", # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::Cadence, # currency: String, - # grouped_with_metered_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 } + # grouped_with_metered_minimum_config: ^(Orb::HashOf[Orb::Unknown]) # } # # Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice ... # in { @@ -641,7 +593,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel # # Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice ... # in { # model_type: "bulk_with_proration", - # bulk_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # bulk_with_proration_config: ^(Orb::HashOf[Orb::Unknown]), # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::Cadence, # currency: String # } @@ -650,7 +602,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel # model_type: "grouped_tiered_package", # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::Cadence, # currency: String, - # grouped_tiered_package_config: -> { Orb::HashOf[Orb::Unknown] === _1 } + # grouped_tiered_package_config: ^(Orb::HashOf[Orb::Unknown]) # } # # Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice ... # in { @@ -670,7 +622,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel # in { # model_type: "cumulative_grouped_bulk", # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::Cadence, - # cumulative_grouped_bulk_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # cumulative_grouped_bulk_config: ^(Orb::HashOf[Orb::Unknown]), # currency: String # } # # Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice ... @@ -820,17 +772,6 @@ class Price < Orb::Union variant :cumulative_grouped_bulk, -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice } - # @example - # ```ruby - # new_floating_unit_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :unit, - # name: String, - # **_ - # } - # ``` class NewFloatingUnitPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -846,7 +787,7 @@ class NewFloatingUnitPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -1010,12 +951,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # unit_config => { - # unit_amount: String - # } - # ``` class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -1031,13 +966,6 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1089,13 +1017,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1148,17 +1069,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_package_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :package, - # name: String, - # **_ - # } - # ``` class NewFloatingPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -1174,7 +1084,7 @@ class NewFloatingPackagePrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -1338,13 +1248,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # package_config => { - # package_amount: String, - # package_size: Integer - # } - # ``` class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -1368,13 +1271,6 @@ class PackageConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1426,13 +1322,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1485,17 +1374,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_matrix_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::Cadence, - # currency: String, - # item_id: String, - # matrix_config: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::MatrixConfig, - # model_type: :matrix, - # **_ - # } - # ``` class NewFloatingMatrixPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -1511,7 +1389,7 @@ class NewFloatingMatrixPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -1675,18 +1553,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # matrix_config => { - # default_unit_amount: String, - # dimensions: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # matrix_values: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::MatrixConfig::MatrixValue - # ] === _1 - # end - # } - # ``` class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -1720,13 +1586,6 @@ class MatrixConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # matrix_value => { - # dimension_values: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # unit_amount: String - # } - # ``` class MatrixValue < Orb::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -1752,13 +1611,6 @@ class MatrixValue < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1810,13 +1662,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1869,17 +1714,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_matrix_with_allocation_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::Cadence, - # currency: String, - # item_id: String, - # matrix_with_allocation_config: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::MatrixWithAllocationConfig, - # model_type: :matrix_with_allocation, - # **_ - # } - # ``` class NewFloatingMatrixWithAllocationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -1895,7 +1729,7 @@ class NewFloatingMatrixWithAllocationPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -2059,19 +1893,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # matrix_with_allocation_config => { - # allocation: Float, - # default_unit_amount: String, - # dimensions: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # matrix_values: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue - # ] === _1 - # end - # } - # ``` class MatrixWithAllocationConfig < Orb::BaseModel # @!attribute allocation # Allocation to be used to calculate the price @@ -2112,13 +1933,6 @@ class MatrixWithAllocationConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # matrix_value => { - # dimension_values: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # unit_amount: String - # } - # ``` class MatrixValue < Orb::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -2144,13 +1958,6 @@ class MatrixValue < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2202,13 +2009,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2261,17 +2061,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_tiered_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :tiered, - # name: String, - # **_ - # } - # ``` class NewFloatingTieredPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -2287,7 +2076,7 @@ class NewFloatingTieredPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -2451,12 +2240,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # tiered_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::TieredConfig::Tier] === _1 } - # } - # ``` class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -2472,14 +2255,6 @@ class TieredConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # first_unit: Float, - # unit_amount: String, - # last_unit: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute first_unit # Inclusive tier starting value @@ -2510,13 +2285,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2568,13 +2336,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2627,17 +2388,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_tiered_bps_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :tiered_bps, - # name: String, - # **_ - # } - # ``` class NewFloatingTieredBpsPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -2653,7 +2403,7 @@ class NewFloatingTieredBpsPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -2817,16 +2567,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # tiered_bps_config => { - # tiers: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::TieredBpsConfig::Tier - # ] === _1 - # end - # } - # ``` class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -2847,15 +2587,6 @@ class TieredBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # minimum_amount: String, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Per-event basis point rate @@ -2893,13 +2624,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2951,13 +2675,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3010,17 +2727,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_bps_price => { - # bps_config: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BpsConfig, - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :bps, - # **_ - # } - # ``` class NewFloatingBpsPrice < Orb::BaseModel # @!attribute bps_config # @@ -3042,7 +2748,7 @@ class NewFloatingBpsPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -3163,13 +2869,6 @@ class NewFloatingBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bps_config => { - # bps: Float, - # per_unit_maximum: String - # } - # ``` class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -3229,13 +2928,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3287,13 +2979,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3346,17 +3031,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_bulk_bps_price => { - # bulk_bps_config: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BulkBpsConfig, - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :bulk_bps, - # **_ - # } - # ``` class NewFloatingBulkBpsPrice < Orb::BaseModel # @!attribute bulk_bps_config # @@ -3378,7 +3052,7 @@ class NewFloatingBulkBpsPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -3499,12 +3173,6 @@ class NewFloatingBulkBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bulk_bps_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BulkBpsConfig::Tier] === _1 } - # } - # ``` class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -3521,14 +3189,6 @@ class BulkBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Basis points to rate on @@ -3596,13 +3256,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3654,13 +3307,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3713,17 +3359,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_bulk_price => { - # bulk_config: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BulkConfig, - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :bulk, - # **_ - # } - # ``` class NewFloatingBulkPrice < Orb::BaseModel # @!attribute bulk_config # @@ -3745,7 +3380,7 @@ class NewFloatingBulkPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -3866,12 +3501,6 @@ class NewFloatingBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bulk_config => { - # tiers: -> { Orb::ArrayOf[Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BulkConfig::Tier] === _1 } - # } - # ``` class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -3887,13 +3516,6 @@ class BulkConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # unit_amount: String, - # maximum_units: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute unit_amount # Amount per unit @@ -3954,13 +3576,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4012,13 +3627,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4071,17 +3679,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_threshold_total_amount_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :threshold_total_amount, - # name: String, - # **_ - # } - # ``` class NewFloatingThresholdTotalAmountPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -4097,7 +3694,7 @@ class NewFloatingThresholdTotalAmountPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -4260,13 +3857,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4318,13 +3908,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4377,17 +3960,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_tiered_package_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :tiered_package, - # name: String, - # **_ - # } - # ``` class NewFloatingTieredPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -4403,7 +3975,7 @@ class NewFloatingTieredPackagePrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -4566,13 +4138,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4624,13 +4189,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4683,17 +4241,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_grouped_tiered_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::Cadence, - # currency: String, - # grouped_tiered_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_tiered, - # **_ - # } - # ``` class NewFloatingGroupedTieredPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -4714,7 +4261,7 @@ class NewFloatingGroupedTieredPrice < Orb::BaseModel required :grouped_tiered_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -4872,13 +4419,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4930,13 +4470,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4989,17 +4522,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_max_group_tiered_package_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::Cadence, - # currency: String, - # item_id: String, - # max_group_tiered_package_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # model_type: :max_group_tiered_package, - # **_ - # } - # ``` class NewFloatingMaxGroupTieredPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -5015,7 +4537,7 @@ class NewFloatingMaxGroupTieredPackagePrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -5178,13 +4700,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5236,13 +4751,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5295,17 +4803,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_tiered_with_minimum_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :tiered_with_minimum, - # name: String, - # **_ - # } - # ``` class NewFloatingTieredWithMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -5321,7 +4818,7 @@ class NewFloatingTieredWithMinimumPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -5484,13 +4981,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5542,13 +5032,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5601,17 +5084,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_package_with_allocation_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :package_with_allocation, - # name: String, - # **_ - # } - # ``` class NewFloatingPackageWithAllocationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -5627,7 +5099,7 @@ class NewFloatingPackageWithAllocationPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -5790,13 +5262,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5848,13 +5313,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5907,17 +5365,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_tiered_package_with_minimum_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :tiered_package_with_minimum, - # name: String, - # **_ - # } - # ``` class NewFloatingTieredPackageWithMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -5933,7 +5380,7 @@ class NewFloatingTieredPackageWithMinimumPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -6096,13 +5543,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6154,13 +5594,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6213,17 +5646,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_unit_with_percent_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :unit_with_percent, - # name: String, - # **_ - # } - # ``` class NewFloatingUnitWithPercentPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -6239,7 +5661,7 @@ class NewFloatingUnitWithPercentPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -6402,13 +5824,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6460,13 +5875,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6519,17 +5927,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_tiered_with_proration_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :tiered_with_proration, - # name: String, - # **_ - # } - # ``` class NewFloatingTieredWithProrationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -6545,7 +5942,7 @@ class NewFloatingTieredWithProrationPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -6708,13 +6105,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6766,13 +6156,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6825,17 +6208,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_unit_with_proration_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :unit_with_proration, - # name: String, - # **_ - # } - # ``` class NewFloatingUnitWithProrationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -6851,7 +6223,7 @@ class NewFloatingUnitWithProrationPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -7014,13 +6386,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7072,13 +6437,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7131,17 +6489,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_grouped_allocation_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::Cadence, - # currency: String, - # grouped_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_allocation, - # **_ - # } - # ``` class NewFloatingGroupedAllocationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -7162,7 +6509,7 @@ class NewFloatingGroupedAllocationPrice < Orb::BaseModel required :grouped_allocation_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -7320,13 +6667,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7378,13 +6718,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7437,17 +6770,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_grouped_with_prorated_minimum_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::Cadence, - # currency: String, - # grouped_with_prorated_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_with_prorated_minimum, - # **_ - # } - # ``` class NewFloatingGroupedWithProratedMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -7468,7 +6790,7 @@ class NewFloatingGroupedWithProratedMinimumPrice < Orb::BaseModel required :grouped_with_prorated_minimum_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -7626,13 +6948,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7684,13 +6999,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7743,17 +7051,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_grouped_with_metered_minimum_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::Cadence, - # currency: String, - # grouped_with_metered_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_with_metered_minimum, - # **_ - # } - # ``` class NewFloatingGroupedWithMeteredMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -7774,7 +7071,7 @@ class NewFloatingGroupedWithMeteredMinimumPrice < Orb::BaseModel required :grouped_with_metered_minimum_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -7932,13 +7229,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7990,13 +7280,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8049,17 +7332,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_matrix_with_display_name_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::Cadence, - # currency: String, - # item_id: String, - # matrix_with_display_name_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # model_type: :matrix_with_display_name, - # **_ - # } - # ``` class NewFloatingMatrixWithDisplayNamePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -8075,7 +7347,7 @@ class NewFloatingMatrixWithDisplayNamePrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -8238,13 +7510,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8296,13 +7561,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8355,17 +7613,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_bulk_with_proration_price => { - # bulk_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :bulk_with_proration, - # **_ - # } - # ``` class NewFloatingBulkWithProrationPrice < Orb::BaseModel # @!attribute bulk_with_proration_config # @@ -8386,7 +7633,7 @@ class NewFloatingBulkWithProrationPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -8544,13 +7791,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8602,13 +7842,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8661,17 +7894,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_grouped_tiered_package_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::Cadence, - # currency: String, - # grouped_tiered_package_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_tiered_package, - # **_ - # } - # ``` class NewFloatingGroupedTieredPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -8692,7 +7914,7 @@ class NewFloatingGroupedTieredPackagePrice < Orb::BaseModel required :grouped_tiered_package_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -8850,13 +8072,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8908,13 +8123,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8967,17 +8175,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_scalable_matrix_with_unit_pricing_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :scalable_matrix_with_unit_pricing, - # name: String, - # **_ - # } - # ``` class NewFloatingScalableMatrixWithUnitPricingPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -8993,7 +8190,7 @@ class NewFloatingScalableMatrixWithUnitPricingPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -9156,13 +8353,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9214,13 +8404,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9273,17 +8456,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_scalable_matrix_with_tiered_pricing_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::Cadence, - # currency: String, - # item_id: String, - # model_type: :scalable_matrix_with_tiered_pricing, - # name: String, - # **_ - # } - # ``` class NewFloatingScalableMatrixWithTieredPricingPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -9299,7 +8471,7 @@ class NewFloatingScalableMatrixWithTieredPricingPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -9462,13 +8634,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9520,13 +8685,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9579,17 +8737,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_floating_cumulative_grouped_bulk_price => { - # cadence: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::Cadence, - # cumulative_grouped_bulk_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # currency: String, - # item_id: String, - # model_type: :cumulative_grouped_bulk, - # **_ - # } - # ``` class NewFloatingCumulativeGroupedBulkPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -9610,7 +8757,7 @@ class NewFloatingCumulativeGroupedBulkPrice < Orb::BaseModel required :currency, String # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -9768,13 +8915,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9826,13 +8966,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9887,14 +9020,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # add_adjustment => { - # adjustment: Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment, - # start_date: Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::StartDate, - # end_date: Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::EndDate - # } - # ``` class AddAdjustment < Orb::BaseModel # @!attribute adjustment # The definition of a new adjustment to create and add to the subscription. @@ -9938,14 +9063,14 @@ class AddAdjustment < Orb::BaseModel # case adjustment # in { # adjustment_type: "percentage_discount", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # percentage_discount: Float, # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewPercentageDiscount ... # in { # adjustment_type: "usage_discount", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # usage_discount: Float, # is_invoice_level: Orb::BooleanModel # } @@ -9953,20 +9078,20 @@ class AddAdjustment < Orb::BaseModel # in { # adjustment_type: "amount_discount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewAmountDiscount ... # in { # adjustment_type: "minimum", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # item_id: String, # minimum_amount: String # } # # Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewMinimum ... # in { # adjustment_type: "maximum", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # maximum_amount: String, # is_invoice_level: Orb::BooleanModel # } @@ -10007,15 +9132,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewMaximum } - # @example - # ```ruby - # new_percentage_discount => { - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # percentage_discount: Float, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewPercentageDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -10063,15 +9179,6 @@ class NewPercentageDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_usage_discount => { - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # usage_discount: Float, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewUsageDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -10111,15 +9218,6 @@ class NewUsageDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_amount_discount => { - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewAmountDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -10159,16 +9257,6 @@ class NewAmountDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_minimum => { - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # item_id: String, - # minimum_amount: String, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewMinimum < Orb::BaseModel # @!attribute adjustment_type # @@ -10215,15 +9303,6 @@ class NewMinimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_maximum => { - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewMaximum < Orb::BaseModel # @!attribute adjustment_type # @@ -10305,16 +9384,6 @@ class EndDate < Orb::Union end end - # @example - # ```ruby - # edit => { - # price_interval_id: String, - # billing_cycle_day: Integer, - # end_date: Orb::Models::SubscriptionPriceIntervalsParams::Edit::EndDate, - # fixed_fee_quantity_transitions: -> { Orb::ArrayOf[Orb::Models::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition] === _1 }, - # start_date: Orb::Models::SubscriptionPriceIntervalsParams::Edit::StartDate - # } - # ``` class Edit < Orb::BaseModel # @!attribute price_interval_id # The id of the price interval to edit. @@ -10398,13 +9467,6 @@ class EndDate < Orb::Union variant enum: -> { Orb::Models::BillingCycleRelativeDate } end - # @example - # ```ruby - # fixed_fee_quantity_transition => { - # effective_date: Time, - # quantity: Integer - # } - # ``` class FixedFeeQuantityTransition < Orb::BaseModel # @!attribute effective_date # The date that the fixed fee quantity transition should take effect. @@ -10448,14 +9510,6 @@ class StartDate < Orb::Union end end - # @example - # ```ruby - # edit_adjustment => { - # adjustment_interval_id: String, - # end_date: Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment::EndDate, - # start_date: Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment::StartDate - # } - # ``` class EditAdjustment < Orb::BaseModel # @!attribute adjustment_interval_id # The id of the adjustment interval to edit. diff --git a/lib/orb/models/subscription_price_intervals_response.rb b/lib/orb/models/subscription_price_intervals_response.rb index 9e86869f..fb439bbd 100644 --- a/lib/orb/models/subscription_price_intervals_response.rb +++ b/lib/orb/models/subscription_price_intervals_response.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # subscription_price_intervals_response => { - # id: String, - # active_plan_phase_order: Integer, - # adjustment_intervals: -> { Orb::ArrayOf[Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval] === _1 }, - # auto_collection: Orb::BooleanModel, - # billing_cycle_anchor_configuration: Orb::Models::SubscriptionPriceIntervalsResponse::BillingCycleAnchorConfiguration, - # **_ - # } - # ``` class SubscriptionPriceIntervalsResponse < Orb::BaseModel # @!attribute id # @@ -262,16 +251,6 @@ class SubscriptionPriceIntervalsResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # adjustment_interval => { - # id: String, - # adjustment: Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # start_date: Time - # } - # ``` class AdjustmentInterval < Orb::BaseModel # @!attribute id # @@ -321,7 +300,7 @@ class AdjustmentInterval < Orb::BaseModel # in { # adjustment_type: "usage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment ... @@ -329,27 +308,27 @@ class AdjustmentInterval < Orb::BaseModel # adjustment_type: "amount_discount", # id: String, # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment ... # in { # adjustment_type: "percentage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment ... # in { # adjustment_type: "minimum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment ... # in { # adjustment_type: "maximum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment ... @@ -389,17 +368,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment } - # @example - # ```ruby - # plan_phase_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # plan_phase_order: Integer, - # **_ - # } - # ``` class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -468,17 +436,6 @@ class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -547,17 +504,6 @@ class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # percentage_discount: Float, - # **_ - # } - # ``` class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -626,17 +572,6 @@ class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # item_id: String, - # **_ - # } - # ``` class PlanPhaseMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -713,17 +648,6 @@ class PlanPhaseMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # maximum_amount: String, - # **_ - # } - # ``` class PlanPhaseMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -794,14 +718,6 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_anchor_configuration => { - # day: Integer, - # month: Integer, - # year: Integer - # } - # ``` class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -845,21 +761,21 @@ class BillingCycleAnchorConfiguration < Orb::BaseModel # in { # discount_type: "amount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::AmountDiscountInterval ... # in { # discount_type: "percentage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::PercentageDiscountInterval ... # in { # discount_type: "usage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::UsageDiscountInterval ... @@ -889,16 +805,6 @@ class DiscountInterval < Orb::Union variant :usage, -> { Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::UsageDiscountInterval } - # @example - # ```ruby - # amount_discount_interval => { - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :amount, - # end_date: Time - # } - # ``` class AmountDiscountInterval < Orb::BaseModel # @!attribute amount_discount # Only available if discount_type is `amount`. @@ -958,16 +864,6 @@ class AmountDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # percentage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :percentage, - # end_date: Time, - # percentage_discount: Float - # } - # ``` class PercentageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1028,16 +924,6 @@ class PercentageDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # usage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :usage, - # end_date: Time, - # start_date: Time - # } - # ``` class UsageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1099,15 +985,6 @@ class UsageDiscountInterval < Orb::BaseModel end end - # @example - # ```ruby - # fixed_fee_quantity_schedule => { - # end_date: Time, - # price_id: String, - # quantity: Float, - # start_date: Time - # } - # ``` class FixedFeeQuantitySchedule < Orb::BaseModel # @!attribute end_date # @@ -1140,16 +1017,6 @@ class FixedFeeQuantitySchedule < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # maximum_amount: String, - # start_date: Time - # } - # ``` class MaximumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this maximum interval applies to. @@ -1194,16 +1061,6 @@ class MaximumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # minimum_amount: String, - # start_date: Time - # } - # ``` class MinimumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this minimum interval applies to. @@ -1248,17 +1105,6 @@ class MinimumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # price_interval => { - # id: String, - # billing_cycle_day: Integer, - # current_billing_period_end_date: Time, - # current_billing_period_start_date: Time, - # end_date: Time, - # **_ - # } - # ``` class PriceInterval < Orb::BaseModel # @!attribute id # @@ -1355,14 +1201,6 @@ class PriceInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # fixed_fee_quantity_transition => { - # effective_date: Time, - # price_id: String, - # quantity: Integer - # } - # ``` class FixedFeeQuantityTransition < Orb::BaseModel # @!attribute effective_date # @@ -1390,14 +1228,6 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end - # @example - # ```ruby - # redeemed_coupon => { - # coupon_id: String, - # end_date: Time, - # start_date: Time - # } - # ``` class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1450,12 +1280,6 @@ class Status < Orb::Enum # def self.values; end end - # @example - # ```ruby - # trial_info => { - # end_date: Time - # } - # ``` class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_schedule_plan_change_params.rb b/lib/orb/models/subscription_schedule_plan_change_params.rb index e99ec31e..2f4dbef2 100644 --- a/lib/orb/models/subscription_schedule_plan_change_params.rb +++ b/lib/orb/models/subscription_schedule_plan_change_params.rb @@ -286,15 +286,6 @@ class ChangeOption < Orb::Enum # def self.values; end end - # @example - # ```ruby - # add_adjustment => { - # adjustment: Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment, - # end_date: Time, - # plan_phase_order: Integer, - # start_date: Time - # } - # ``` class AddAdjustment < Orb::BaseModel # @!attribute adjustment # The definition of a new adjustment to create and add to the subscription. @@ -343,14 +334,14 @@ class AddAdjustment < Orb::BaseModel # case adjustment # in { # adjustment_type: "percentage_discount", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # percentage_discount: Float, # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewPercentageDiscount ... # in { # adjustment_type: "usage_discount", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # usage_discount: Float, # is_invoice_level: Orb::BooleanModel # } @@ -358,20 +349,20 @@ class AddAdjustment < Orb::BaseModel # in { # adjustment_type: "amount_discount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewAmountDiscount ... # in { # adjustment_type: "minimum", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # item_id: String, # minimum_amount: String # } # # Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewMinimum ... # in { # adjustment_type: "maximum", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # maximum_amount: String, # is_invoice_level: Orb::BooleanModel # } @@ -412,15 +403,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewMaximum } - # @example - # ```ruby - # new_percentage_discount => { - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # percentage_discount: Float, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewPercentageDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -468,15 +450,6 @@ class NewPercentageDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_usage_discount => { - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # usage_discount: Float, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewUsageDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -516,15 +489,6 @@ class NewUsageDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_amount_discount => { - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewAmountDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -564,16 +528,6 @@ class NewAmountDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_minimum => { - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # item_id: String, - # minimum_amount: String, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewMinimum < Orb::BaseModel # @!attribute adjustment_type # @@ -620,15 +574,6 @@ class NewMinimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_maximum => { - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewMaximum < Orb::BaseModel # @!attribute adjustment_type # @@ -670,17 +615,6 @@ class NewMaximum < Orb::BaseModel end end - # @example - # ```ruby - # add_price => { - # allocation_price: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice, - # discounts: -> { Orb::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Discount] === _1 }, - # end_date: Time, - # external_price_id: String, - # maximum_amount: String, - # **_ - # } - # ``` class AddPrice < Orb::BaseModel # @!attribute allocation_price # The definition of a new allocation price to create and add to the subscription. @@ -785,15 +719,6 @@ class AddPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # allocation_price => { - # amount: String, - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::Cadence, - # currency: String, - # expires_at_end_of_cadence: Orb::BooleanModel - # } - # ``` class AllocationPrice < Orb::BaseModel # @!attribute amount # An amount of the currency to allocate to the customer at the specified cadence. @@ -872,15 +797,6 @@ class Cadence < Orb::Enum end end - # @example - # ```ruby - # discount => { - # discount_type: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Discount::DiscountType, - # amount_discount: String, - # percentage_discount: Float, - # usage_discount: Float - # } - # ``` class Discount < Orb::BaseModel # @!attribute discount_type # @@ -1060,20 +976,20 @@ class DiscountType < Orb::Enum # in { # model_type: "grouped_allocation", # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence, - # grouped_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # grouped_allocation_config: ^(Orb::HashOf[Orb::Unknown]), # item_id: String # } # # Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice ... # in { # model_type: "grouped_with_prorated_minimum", # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence, - # grouped_with_prorated_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # grouped_with_prorated_minimum_config: ^(Orb::HashOf[Orb::Unknown]), # item_id: String # } # # Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice ... # in { # model_type: "bulk_with_proration", - # bulk_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # bulk_with_proration_config: ^(Orb::HashOf[Orb::Unknown]), # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence, # item_id: String # } @@ -1179,17 +1095,6 @@ class Price < Orb::Union variant :bulk_with_proration, -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice } - # @example - # ```ruby - # new_subscription_unit_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence, - # item_id: String, - # model_type: :unit, - # name: String, - # unit_config: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::UnitConfig, - # **_ - # } - # ``` class NewSubscriptionUnitPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -1199,7 +1104,7 @@ class NewSubscriptionUnitPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -1379,12 +1284,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # unit_config => { - # unit_amount: String - # } - # ``` class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -1400,13 +1299,6 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1458,13 +1350,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1517,17 +1402,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_package_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence, - # item_id: String, - # model_type: :package, - # name: String, - # package_config: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::PackageConfig, - # **_ - # } - # ``` class NewSubscriptionPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -1537,7 +1411,7 @@ class NewSubscriptionPackagePrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -1717,13 +1591,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # package_config => { - # package_amount: String, - # package_size: Integer - # } - # ``` class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -1747,13 +1614,6 @@ class PackageConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1805,13 +1665,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1864,17 +1717,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_matrix_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence, - # item_id: String, - # matrix_config: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig, - # model_type: :matrix, - # name: String, - # **_ - # } - # ``` class NewSubscriptionMatrixPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -1884,7 +1726,7 @@ class NewSubscriptionMatrixPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -2064,18 +1906,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # matrix_config => { - # default_unit_amount: String, - # dimensions: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # matrix_values: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue - # ] === _1 - # end - # } - # ``` class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -2109,13 +1939,6 @@ class MatrixConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # matrix_value => { - # dimension_values: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # unit_amount: String - # } - # ``` class MatrixValue < Orb::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -2141,13 +1964,6 @@ class MatrixValue < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2199,13 +2015,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2258,17 +2067,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence, - # item_id: String, - # model_type: :tiered, - # name: String, - # tiered_config: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig, - # **_ - # } - # ``` class NewSubscriptionTieredPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -2278,7 +2076,7 @@ class NewSubscriptionTieredPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -2458,16 +2256,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # tiered_config => { - # tiers: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier - # ] === _1 - # end - # } - # ``` class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -2487,14 +2275,6 @@ class TieredConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # first_unit: Float, - # unit_amount: String, - # last_unit: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute first_unit # Inclusive tier starting value @@ -2525,13 +2305,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2583,13 +2356,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2642,17 +2408,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_bps_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence, - # item_id: String, - # model_type: :tiered_bps, - # name: String, - # tiered_bps_config: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig, - # **_ - # } - # ``` class NewSubscriptionTieredBpsPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -2662,7 +2417,7 @@ class NewSubscriptionTieredBpsPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -2842,16 +2597,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # tiered_bps_config => { - # tiers: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier - # ] === _1 - # end - # } - # ``` class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -2872,15 +2617,6 @@ class TieredBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # minimum_amount: String, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Per-event basis point rate @@ -2918,13 +2654,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2976,13 +2705,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3035,17 +2757,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bps_price => { - # bps_config: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BpsConfig, - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence, - # item_id: String, - # model_type: :bps, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBpsPrice < Orb::BaseModel # @!attribute bps_config # @@ -3061,7 +2772,7 @@ class NewSubscriptionBpsPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -3198,13 +2909,6 @@ class NewSubscriptionBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bps_config => { - # bps: Float, - # per_unit_maximum: String - # } - # ``` class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -3264,13 +2968,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3322,13 +3019,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3381,17 +3071,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bulk_bps_price => { - # bulk_bps_config: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig, - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence, - # item_id: String, - # model_type: :bulk_bps, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBulkBpsPrice < Orb::BaseModel # @!attribute bulk_bps_config # @@ -3407,7 +3086,7 @@ class NewSubscriptionBulkBpsPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -3544,16 +3223,6 @@ class NewSubscriptionBulkBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bulk_bps_config => { - # tiers: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier - # ] === _1 - # end - # } - # ``` class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -3574,14 +3243,6 @@ class BulkBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Basis points to rate on @@ -3649,13 +3310,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3707,13 +3361,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3766,17 +3413,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bulk_price => { - # bulk_config: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig, - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence, - # item_id: String, - # model_type: :bulk, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBulkPrice < Orb::BaseModel # @!attribute bulk_config # @@ -3792,7 +3428,7 @@ class NewSubscriptionBulkPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -3929,16 +3565,6 @@ class NewSubscriptionBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bulk_config => { - # tiers: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier - # ] === _1 - # end - # } - # ``` class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -3958,13 +3584,6 @@ class BulkConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # unit_amount: String, - # maximum_units: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute unit_amount # Amount per unit @@ -4025,13 +3644,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4083,13 +3695,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4142,17 +3747,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_threshold_total_amount_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence, - # item_id: String, - # model_type: :threshold_total_amount, - # name: String, - # threshold_total_amount_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionThresholdTotalAmountPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -4162,7 +3756,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -4341,13 +3935,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4399,13 +3986,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4458,17 +4038,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_package_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence, - # item_id: String, - # model_type: :tiered_package, - # name: String, - # tiered_package_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionTieredPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -4478,7 +4047,7 @@ class NewSubscriptionTieredPackagePrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -4657,13 +4226,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4715,13 +4277,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4774,17 +4329,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_with_minimum_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence, - # item_id: String, - # model_type: :tiered_with_minimum, - # name: String, - # tiered_with_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionTieredWithMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -4794,7 +4338,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -4973,13 +4517,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5031,13 +4568,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5090,17 +4620,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_unit_with_percent_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence, - # item_id: String, - # model_type: :unit_with_percent, - # name: String, - # unit_with_percent_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionUnitWithPercentPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -5110,7 +4629,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -5289,13 +4808,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5347,13 +4859,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5406,17 +4911,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_package_with_allocation_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence, - # item_id: String, - # model_type: :package_with_allocation, - # name: String, - # package_with_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionPackageWithAllocationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -5426,7 +4920,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -5605,13 +5099,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5663,13 +5150,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5722,17 +5202,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tier_with_proration_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence, - # item_id: String, - # model_type: :tiered_with_proration, - # name: String, - # tiered_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionTierWithProrationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -5742,7 +5211,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -5921,13 +5390,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5979,13 +5441,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6038,17 +5493,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_unit_with_proration_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence, - # item_id: String, - # model_type: :unit_with_proration, - # name: String, - # unit_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionUnitWithProrationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -6058,7 +5502,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -6237,13 +5681,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6295,13 +5732,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6354,17 +5784,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_grouped_allocation_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence, - # grouped_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_allocation, - # name: String, - # **_ - # } - # ``` class NewSubscriptionGroupedAllocationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -6379,7 +5798,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::BaseModel required :grouped_allocation_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -6553,13 +5972,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6611,13 +6023,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6670,17 +6075,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_grouped_with_prorated_minimum_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence, - # grouped_with_prorated_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_with_prorated_minimum, - # name: String, - # **_ - # } - # ``` class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -6695,7 +6089,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::BaseModel required :grouped_with_prorated_minimum_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -6869,13 +6263,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6927,13 +6314,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6986,17 +6366,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bulk_with_proration_price => { - # bulk_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence, - # item_id: String, - # model_type: :bulk_with_proration, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBulkWithProrationPrice < Orb::BaseModel # @!attribute bulk_with_proration_config # @@ -7011,7 +6380,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -7185,13 +6554,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7243,13 +6605,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7334,14 +6689,6 @@ class BillingCycleAlignment < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_anchor_configuration => { - # day: Integer, - # month: Integer, - # year: Integer - # } - # ``` class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -7377,12 +6724,6 @@ class BillingCycleAnchorConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # remove_adjustment => { - # adjustment_id: String - # } - # ``` class RemoveAdjustment < Orb::BaseModel # @!attribute adjustment_id # The id of the adjustment to remove on the subscription. @@ -7398,13 +6739,6 @@ class RemoveAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # remove_price => { - # external_price_id: String, - # price_id: String - # } - # ``` class RemovePrice < Orb::BaseModel # @!attribute external_price_id # The external price id of the price to remove on the subscription. @@ -7427,13 +6761,6 @@ class RemovePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # replace_adjustment => { - # adjustment: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment, - # replaces_adjustment_id: String - # } - # ``` class ReplaceAdjustment < Orb::BaseModel # @!attribute adjustment # The definition of a new adjustment to create and add to the subscription. @@ -7465,14 +6792,14 @@ class ReplaceAdjustment < Orb::BaseModel # case adjustment # in { # adjustment_type: "percentage_discount", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # percentage_discount: Float, # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewPercentageDiscount ... # in { # adjustment_type: "usage_discount", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # usage_discount: Float, # is_invoice_level: Orb::BooleanModel # } @@ -7480,20 +6807,20 @@ class ReplaceAdjustment < Orb::BaseModel # in { # adjustment_type: "amount_discount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewAmountDiscount ... # in { # adjustment_type: "minimum", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # item_id: String, # minimum_amount: String # } # # Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewMinimum ... # in { # adjustment_type: "maximum", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # maximum_amount: String, # is_invoice_level: Orb::BooleanModel # } @@ -7534,15 +6861,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewMaximum } - # @example - # ```ruby - # new_percentage_discount => { - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # percentage_discount: Float, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewPercentageDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -7590,15 +6908,6 @@ class NewPercentageDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_usage_discount => { - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # usage_discount: Float, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewUsageDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -7638,15 +6947,6 @@ class NewUsageDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_amount_discount => { - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewAmountDiscount < Orb::BaseModel # @!attribute adjustment_type # @@ -7686,16 +6986,6 @@ class NewAmountDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_minimum => { - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # item_id: String, - # minimum_amount: String, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewMinimum < Orb::BaseModel # @!attribute adjustment_type # @@ -7742,15 +7032,6 @@ class NewMinimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # new_maximum => { - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # maximum_amount: String, - # is_invoice_level: Orb::BooleanModel - # } - # ``` class NewMaximum < Orb::BaseModel # @!attribute adjustment_type # @@ -7792,17 +7073,6 @@ class NewMaximum < Orb::BaseModel end end - # @example - # ```ruby - # replace_price => { - # replaces_price_id: String, - # allocation_price: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice, - # discounts: -> { Orb::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Discount] === _1 }, - # external_price_id: String, - # fixed_price_quantity: Float, - # **_ - # } - # ``` class ReplacePrice < Orb::BaseModel # @!attribute replaces_price_id # The id of the price on the plan to replace in the subscription. @@ -7895,15 +7165,6 @@ class ReplacePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # allocation_price => { - # amount: String, - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::Cadence, - # currency: String, - # expires_at_end_of_cadence: Orb::BooleanModel - # } - # ``` class AllocationPrice < Orb::BaseModel # @!attribute amount # An amount of the currency to allocate to the customer at the specified cadence. @@ -7982,15 +7243,6 @@ class Cadence < Orb::Enum end end - # @example - # ```ruby - # discount => { - # discount_type: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Discount::DiscountType, - # amount_discount: String, - # percentage_discount: Float, - # usage_discount: Float - # } - # ``` class Discount < Orb::BaseModel # @!attribute discount_type # @@ -8170,20 +7422,20 @@ class DiscountType < Orb::Enum # in { # model_type: "grouped_allocation", # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence, - # grouped_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # grouped_allocation_config: ^(Orb::HashOf[Orb::Unknown]), # item_id: String # } # # Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice ... # in { # model_type: "grouped_with_prorated_minimum", # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence, - # grouped_with_prorated_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # grouped_with_prorated_minimum_config: ^(Orb::HashOf[Orb::Unknown]), # item_id: String # } # # Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice ... # in { # model_type: "bulk_with_proration", - # bulk_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, + # bulk_with_proration_config: ^(Orb::HashOf[Orb::Unknown]), # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence, # item_id: String # } @@ -8289,17 +7541,6 @@ class Price < Orb::Union variant :bulk_with_proration, -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice } - # @example - # ```ruby - # new_subscription_unit_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence, - # item_id: String, - # model_type: :unit, - # name: String, - # unit_config: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::UnitConfig, - # **_ - # } - # ``` class NewSubscriptionUnitPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -8309,7 +7550,7 @@ class NewSubscriptionUnitPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -8489,12 +7730,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # unit_config => { - # unit_amount: String - # } - # ``` class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -8510,13 +7745,6 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8568,13 +7796,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8627,17 +7848,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_package_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence, - # item_id: String, - # model_type: :package, - # name: String, - # package_config: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::PackageConfig, - # **_ - # } - # ``` class NewSubscriptionPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -8647,7 +7857,7 @@ class NewSubscriptionPackagePrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -8827,13 +8037,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # package_config => { - # package_amount: String, - # package_size: Integer - # } - # ``` class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -8857,13 +8060,6 @@ class PackageConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8915,13 +8111,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8974,17 +8163,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_matrix_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence, - # item_id: String, - # matrix_config: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig, - # model_type: :matrix, - # name: String, - # **_ - # } - # ``` class NewSubscriptionMatrixPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -8994,7 +8172,7 @@ class NewSubscriptionMatrixPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -9174,18 +8352,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # matrix_config => { - # default_unit_amount: String, - # dimensions: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # matrix_values: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue - # ] === _1 - # end - # } - # ``` class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -9219,13 +8385,6 @@ class MatrixConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # matrix_value => { - # dimension_values: -> { Orb::ArrayOf[String, nil?: true] === _1 }, - # unit_amount: String - # } - # ``` class MatrixValue < Orb::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -9251,13 +8410,6 @@ class MatrixValue < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9309,13 +8461,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9368,17 +8513,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence, - # item_id: String, - # model_type: :tiered, - # name: String, - # tiered_config: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig, - # **_ - # } - # ``` class NewSubscriptionTieredPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -9388,7 +8522,7 @@ class NewSubscriptionTieredPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -9568,16 +8702,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # tiered_config => { - # tiers: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier - # ] === _1 - # end - # } - # ``` class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -9597,14 +8721,6 @@ class TieredConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # first_unit: Float, - # unit_amount: String, - # last_unit: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute first_unit # Inclusive tier starting value @@ -9635,13 +8751,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9693,13 +8802,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9752,17 +8854,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_bps_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence, - # item_id: String, - # model_type: :tiered_bps, - # name: String, - # tiered_bps_config: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig, - # **_ - # } - # ``` class NewSubscriptionTieredBpsPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -9772,7 +8863,7 @@ class NewSubscriptionTieredBpsPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -9952,16 +9043,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # tiered_bps_config => { - # tiers: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier - # ] === _1 - # end - # } - # ``` class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -9982,15 +9063,6 @@ class TieredBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # minimum_amount: String, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Per-event basis point rate @@ -10028,13 +9100,6 @@ class Tier < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10086,13 +9151,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10145,17 +9203,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bps_price => { - # bps_config: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BpsConfig, - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence, - # item_id: String, - # model_type: :bps, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBpsPrice < Orb::BaseModel # @!attribute bps_config # @@ -10171,7 +9218,7 @@ class NewSubscriptionBpsPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -10308,13 +9355,6 @@ class NewSubscriptionBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bps_config => { - # bps: Float, - # per_unit_maximum: String - # } - # ``` class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -10374,13 +9414,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10432,13 +9465,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10491,17 +9517,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bulk_bps_price => { - # bulk_bps_config: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig, - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence, - # item_id: String, - # model_type: :bulk_bps, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBulkBpsPrice < Orb::BaseModel # @!attribute bulk_bps_config # @@ -10517,7 +9532,7 @@ class NewSubscriptionBulkBpsPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -10654,16 +9669,6 @@ class NewSubscriptionBulkBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bulk_bps_config => { - # tiers: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier - # ] === _1 - # end - # } - # ``` class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -10684,14 +9689,6 @@ class BulkBpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # bps: Float, - # maximum_amount: String, - # per_unit_maximum: String - # } - # ``` class Tier < Orb::BaseModel # @!attribute bps # Basis points to rate on @@ -10759,13 +9756,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10817,13 +9807,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10876,17 +9859,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bulk_price => { - # bulk_config: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig, - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence, - # item_id: String, - # model_type: :bulk, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBulkPrice < Orb::BaseModel # @!attribute bulk_config # @@ -10902,7 +9874,7 @@ class NewSubscriptionBulkPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -11039,16 +10011,6 @@ class NewSubscriptionBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # bulk_config => { - # tiers: -> do - # Orb::ArrayOf[ - # Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier - # ] === _1 - # end - # } - # ``` class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -11068,13 +10030,6 @@ class BulkConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # tier => { - # unit_amount: String, - # maximum_units: Float - # } - # ``` class Tier < Orb::BaseModel # @!attribute unit_amount # Amount per unit @@ -11135,13 +10090,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11193,13 +10141,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11252,17 +10193,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_threshold_total_amount_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence, - # item_id: String, - # model_type: :threshold_total_amount, - # name: String, - # threshold_total_amount_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionThresholdTotalAmountPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -11272,7 +10202,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -11451,13 +10381,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11509,13 +10432,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11568,17 +10484,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_package_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence, - # item_id: String, - # model_type: :tiered_package, - # name: String, - # tiered_package_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionTieredPackagePrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -11588,7 +10493,7 @@ class NewSubscriptionTieredPackagePrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -11767,13 +10672,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11825,13 +10723,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11884,17 +10775,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tiered_with_minimum_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence, - # item_id: String, - # model_type: :tiered_with_minimum, - # name: String, - # tiered_with_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionTieredWithMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -11904,7 +10784,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -12083,13 +10963,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12141,13 +11014,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12200,17 +11066,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_unit_with_percent_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence, - # item_id: String, - # model_type: :unit_with_percent, - # name: String, - # unit_with_percent_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionUnitWithPercentPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -12220,7 +11075,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -12399,13 +11254,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12457,13 +11305,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12516,17 +11357,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_package_with_allocation_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence, - # item_id: String, - # model_type: :package_with_allocation, - # name: String, - # package_with_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionPackageWithAllocationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -12536,7 +11366,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -12715,13 +11545,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12773,13 +11596,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12832,17 +11648,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_tier_with_proration_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence, - # item_id: String, - # model_type: :tiered_with_proration, - # name: String, - # tiered_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionTierWithProrationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -12852,7 +11657,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -13031,13 +11836,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13089,13 +11887,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13148,17 +11939,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_unit_with_proration_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence, - # item_id: String, - # model_type: :unit_with_proration, - # name: String, - # unit_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # **_ - # } - # ``` class NewSubscriptionUnitWithProrationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -13168,7 +11948,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -13347,13 +12127,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13405,13 +12178,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13464,17 +12230,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_grouped_allocation_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence, - # grouped_allocation_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_allocation, - # name: String, - # **_ - # } - # ``` class NewSubscriptionGroupedAllocationPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -13489,7 +12244,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::BaseModel required :grouped_allocation_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -13663,13 +12418,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13721,13 +12469,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13780,17 +12521,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_grouped_with_prorated_minimum_price => { - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence, - # grouped_with_prorated_minimum_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # item_id: String, - # model_type: :grouped_with_prorated_minimum, - # name: String, - # **_ - # } - # ``` class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::BaseModel # @!attribute cadence # The cadence to bill for this price on. @@ -13805,7 +12535,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::BaseModel required :grouped_with_prorated_minimum_config, Orb::HashOf[Orb::Unknown] # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -13979,13 +12709,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14037,13 +12760,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14096,17 +12812,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # new_subscription_bulk_with_proration_price => { - # bulk_with_proration_config: -> { Orb::HashOf[Orb::Unknown] === _1 }, - # cadence: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence, - # item_id: String, - # model_type: :bulk_with_proration, - # name: String, - # **_ - # } - # ``` class NewSubscriptionBulkWithProrationPrice < Orb::BaseModel # @!attribute bulk_with_proration_config # @@ -14121,7 +12826,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::BaseModel enum: -> { Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence } # @!attribute item_id - # The id of the item the plan will be associated with. + # The id of the item the price will be associated with. # # @return [String] required :item_id, String @@ -14295,13 +13000,6 @@ class Cadence < Orb::Enum # def self.values; end end - # @example - # ```ruby - # billing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit - # } - # ``` class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14353,13 +13051,6 @@ class DurationUnit < Orb::Enum end end - # @example - # ```ruby - # invoicing_cycle_configuration => { - # duration: Integer, - # duration_unit: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit - # } - # ``` class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. diff --git a/lib/orb/models/subscription_schedule_plan_change_response.rb b/lib/orb/models/subscription_schedule_plan_change_response.rb index d9a036b5..766ed478 100644 --- a/lib/orb/models/subscription_schedule_plan_change_response.rb +++ b/lib/orb/models/subscription_schedule_plan_change_response.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # subscription_schedule_plan_change_response => { - # id: String, - # active_plan_phase_order: Integer, - # adjustment_intervals: -> { Orb::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval] === _1 }, - # auto_collection: Orb::BooleanModel, - # billing_cycle_anchor_configuration: Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration, - # **_ - # } - # ``` class SubscriptionSchedulePlanChangeResponse < Orb::BaseModel # @!attribute id # @@ -262,16 +251,6 @@ class SubscriptionSchedulePlanChangeResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # adjustment_interval => { - # id: String, - # adjustment: Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # start_date: Time - # } - # ``` class AdjustmentInterval < Orb::BaseModel # @!attribute id # @@ -321,7 +300,7 @@ class AdjustmentInterval < Orb::BaseModel # in { # adjustment_type: "usage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment ... @@ -329,27 +308,27 @@ class AdjustmentInterval < Orb::BaseModel # adjustment_type: "amount_discount", # id: String, # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment ... # in { # adjustment_type: "percentage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment ... # in { # adjustment_type: "minimum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment ... # in { # adjustment_type: "maximum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment ... @@ -389,17 +368,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment } - # @example - # ```ruby - # plan_phase_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # plan_phase_order: Integer, - # **_ - # } - # ``` class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -468,17 +436,6 @@ class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -547,17 +504,6 @@ class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # percentage_discount: Float, - # **_ - # } - # ``` class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -626,17 +572,6 @@ class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # item_id: String, - # **_ - # } - # ``` class PlanPhaseMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -713,17 +648,6 @@ class PlanPhaseMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # maximum_amount: String, - # **_ - # } - # ``` class PlanPhaseMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -794,14 +718,6 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_anchor_configuration => { - # day: Integer, - # month: Integer, - # year: Integer - # } - # ``` class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -845,21 +761,21 @@ class BillingCycleAnchorConfiguration < Orb::BaseModel # in { # discount_type: "amount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::AmountDiscountInterval ... # in { # discount_type: "percentage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval ... # in { # discount_type: "usage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval ... @@ -889,16 +805,6 @@ class DiscountInterval < Orb::Union variant :usage, -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval } - # @example - # ```ruby - # amount_discount_interval => { - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :amount, - # end_date: Time - # } - # ``` class AmountDiscountInterval < Orb::BaseModel # @!attribute amount_discount # Only available if discount_type is `amount`. @@ -958,16 +864,6 @@ class AmountDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # percentage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :percentage, - # end_date: Time, - # percentage_discount: Float - # } - # ``` class PercentageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1028,16 +924,6 @@ class PercentageDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # usage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :usage, - # end_date: Time, - # start_date: Time - # } - # ``` class UsageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1099,15 +985,6 @@ class UsageDiscountInterval < Orb::BaseModel end end - # @example - # ```ruby - # fixed_fee_quantity_schedule => { - # end_date: Time, - # price_id: String, - # quantity: Float, - # start_date: Time - # } - # ``` class FixedFeeQuantitySchedule < Orb::BaseModel # @!attribute end_date # @@ -1140,16 +1017,6 @@ class FixedFeeQuantitySchedule < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # maximum_amount: String, - # start_date: Time - # } - # ``` class MaximumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this maximum interval applies to. @@ -1194,16 +1061,6 @@ class MaximumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # minimum_amount: String, - # start_date: Time - # } - # ``` class MinimumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this minimum interval applies to. @@ -1248,17 +1105,6 @@ class MinimumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # price_interval => { - # id: String, - # billing_cycle_day: Integer, - # current_billing_period_end_date: Time, - # current_billing_period_start_date: Time, - # end_date: Time, - # **_ - # } - # ``` class PriceInterval < Orb::BaseModel # @!attribute id # @@ -1355,14 +1201,6 @@ class PriceInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # fixed_fee_quantity_transition => { - # effective_date: Time, - # price_id: String, - # quantity: Integer - # } - # ``` class FixedFeeQuantityTransition < Orb::BaseModel # @!attribute effective_date # @@ -1390,14 +1228,6 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end - # @example - # ```ruby - # redeemed_coupon => { - # coupon_id: String, - # end_date: Time, - # start_date: Time - # } - # ``` class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1450,12 +1280,6 @@ class Status < Orb::Enum # def self.values; end end - # @example - # ```ruby - # trial_info => { - # end_date: Time - # } - # ``` class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_trigger_phase_response.rb b/lib/orb/models/subscription_trigger_phase_response.rb index 6e96e28f..1482a7cc 100644 --- a/lib/orb/models/subscription_trigger_phase_response.rb +++ b/lib/orb/models/subscription_trigger_phase_response.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # subscription_trigger_phase_response => { - # id: String, - # active_plan_phase_order: Integer, - # adjustment_intervals: -> { Orb::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval] === _1 }, - # auto_collection: Orb::BooleanModel, - # billing_cycle_anchor_configuration: Orb::Models::SubscriptionTriggerPhaseResponse::BillingCycleAnchorConfiguration, - # **_ - # } - # ``` class SubscriptionTriggerPhaseResponse < Orb::BaseModel # @!attribute id # @@ -262,16 +251,6 @@ class SubscriptionTriggerPhaseResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # adjustment_interval => { - # id: String, - # adjustment: Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # start_date: Time - # } - # ``` class AdjustmentInterval < Orb::BaseModel # @!attribute id # @@ -321,7 +300,7 @@ class AdjustmentInterval < Orb::BaseModel # in { # adjustment_type: "usage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment ... @@ -329,27 +308,27 @@ class AdjustmentInterval < Orb::BaseModel # adjustment_type: "amount_discount", # id: String, # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment ... # in { # adjustment_type: "percentage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment ... # in { # adjustment_type: "minimum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment ... # in { # adjustment_type: "maximum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment ... @@ -389,17 +368,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment } - # @example - # ```ruby - # plan_phase_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # plan_phase_order: Integer, - # **_ - # } - # ``` class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -468,17 +436,6 @@ class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -547,17 +504,6 @@ class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # percentage_discount: Float, - # **_ - # } - # ``` class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -626,17 +572,6 @@ class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # item_id: String, - # **_ - # } - # ``` class PlanPhaseMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -713,17 +648,6 @@ class PlanPhaseMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # maximum_amount: String, - # **_ - # } - # ``` class PlanPhaseMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -794,14 +718,6 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_anchor_configuration => { - # day: Integer, - # month: Integer, - # year: Integer - # } - # ``` class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -845,21 +761,21 @@ class BillingCycleAnchorConfiguration < Orb::BaseModel # in { # discount_type: "amount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval ... # in { # discount_type: "percentage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval ... # in { # discount_type: "usage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval ... @@ -889,16 +805,6 @@ class DiscountInterval < Orb::Union variant :usage, -> { Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval } - # @example - # ```ruby - # amount_discount_interval => { - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :amount, - # end_date: Time - # } - # ``` class AmountDiscountInterval < Orb::BaseModel # @!attribute amount_discount # Only available if discount_type is `amount`. @@ -958,16 +864,6 @@ class AmountDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # percentage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :percentage, - # end_date: Time, - # percentage_discount: Float - # } - # ``` class PercentageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1028,16 +924,6 @@ class PercentageDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # usage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :usage, - # end_date: Time, - # start_date: Time - # } - # ``` class UsageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1099,15 +985,6 @@ class UsageDiscountInterval < Orb::BaseModel end end - # @example - # ```ruby - # fixed_fee_quantity_schedule => { - # end_date: Time, - # price_id: String, - # quantity: Float, - # start_date: Time - # } - # ``` class FixedFeeQuantitySchedule < Orb::BaseModel # @!attribute end_date # @@ -1140,16 +1017,6 @@ class FixedFeeQuantitySchedule < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # maximum_amount: String, - # start_date: Time - # } - # ``` class MaximumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this maximum interval applies to. @@ -1194,16 +1061,6 @@ class MaximumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # minimum_amount: String, - # start_date: Time - # } - # ``` class MinimumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this minimum interval applies to. @@ -1248,17 +1105,6 @@ class MinimumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # price_interval => { - # id: String, - # billing_cycle_day: Integer, - # current_billing_period_end_date: Time, - # current_billing_period_start_date: Time, - # end_date: Time, - # **_ - # } - # ``` class PriceInterval < Orb::BaseModel # @!attribute id # @@ -1355,14 +1201,6 @@ class PriceInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # fixed_fee_quantity_transition => { - # effective_date: Time, - # price_id: String, - # quantity: Integer - # } - # ``` class FixedFeeQuantityTransition < Orb::BaseModel # @!attribute effective_date # @@ -1390,14 +1228,6 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end - # @example - # ```ruby - # redeemed_coupon => { - # coupon_id: String, - # end_date: Time, - # start_date: Time - # } - # ``` class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1450,12 +1280,6 @@ class Status < Orb::Enum # def self.values; end end - # @example - # ```ruby - # trial_info => { - # end_date: Time - # } - # ``` class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_unschedule_cancellation_response.rb b/lib/orb/models/subscription_unschedule_cancellation_response.rb index 1f1bb4b2..f68703ab 100644 --- a/lib/orb/models/subscription_unschedule_cancellation_response.rb +++ b/lib/orb/models/subscription_unschedule_cancellation_response.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # subscription_unschedule_cancellation_response => { - # id: String, - # active_plan_phase_order: Integer, - # adjustment_intervals: -> { Orb::ArrayOf[Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval] === _1 }, - # auto_collection: Orb::BooleanModel, - # billing_cycle_anchor_configuration: Orb::Models::SubscriptionUnscheduleCancellationResponse::BillingCycleAnchorConfiguration, - # **_ - # } - # ``` class SubscriptionUnscheduleCancellationResponse < Orb::BaseModel # @!attribute id # @@ -262,16 +251,6 @@ class SubscriptionUnscheduleCancellationResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # adjustment_interval => { - # id: String, - # adjustment: Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # start_date: Time - # } - # ``` class AdjustmentInterval < Orb::BaseModel # @!attribute id # @@ -321,7 +300,7 @@ class AdjustmentInterval < Orb::BaseModel # in { # adjustment_type: "usage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment ... @@ -329,27 +308,27 @@ class AdjustmentInterval < Orb::BaseModel # adjustment_type: "amount_discount", # id: String, # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment ... # in { # adjustment_type: "percentage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment ... # in { # adjustment_type: "minimum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment ... # in { # adjustment_type: "maximum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment ... @@ -389,17 +368,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment } - # @example - # ```ruby - # plan_phase_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # plan_phase_order: Integer, - # **_ - # } - # ``` class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -468,17 +436,6 @@ class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -547,17 +504,6 @@ class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # percentage_discount: Float, - # **_ - # } - # ``` class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -626,17 +572,6 @@ class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # item_id: String, - # **_ - # } - # ``` class PlanPhaseMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -713,17 +648,6 @@ class PlanPhaseMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # maximum_amount: String, - # **_ - # } - # ``` class PlanPhaseMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -794,14 +718,6 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_anchor_configuration => { - # day: Integer, - # month: Integer, - # year: Integer - # } - # ``` class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -845,21 +761,21 @@ class BillingCycleAnchorConfiguration < Orb::BaseModel # in { # discount_type: "amount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval ... # in { # discount_type: "percentage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval ... # in { # discount_type: "usage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval ... @@ -889,16 +805,6 @@ class DiscountInterval < Orb::Union variant :usage, -> { Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval } - # @example - # ```ruby - # amount_discount_interval => { - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :amount, - # end_date: Time - # } - # ``` class AmountDiscountInterval < Orb::BaseModel # @!attribute amount_discount # Only available if discount_type is `amount`. @@ -958,16 +864,6 @@ class AmountDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # percentage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :percentage, - # end_date: Time, - # percentage_discount: Float - # } - # ``` class PercentageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1028,16 +924,6 @@ class PercentageDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # usage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :usage, - # end_date: Time, - # start_date: Time - # } - # ``` class UsageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1099,15 +985,6 @@ class UsageDiscountInterval < Orb::BaseModel end end - # @example - # ```ruby - # fixed_fee_quantity_schedule => { - # end_date: Time, - # price_id: String, - # quantity: Float, - # start_date: Time - # } - # ``` class FixedFeeQuantitySchedule < Orb::BaseModel # @!attribute end_date # @@ -1140,16 +1017,6 @@ class FixedFeeQuantitySchedule < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # maximum_amount: String, - # start_date: Time - # } - # ``` class MaximumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this maximum interval applies to. @@ -1194,16 +1061,6 @@ class MaximumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # minimum_amount: String, - # start_date: Time - # } - # ``` class MinimumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this minimum interval applies to. @@ -1248,17 +1105,6 @@ class MinimumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # price_interval => { - # id: String, - # billing_cycle_day: Integer, - # current_billing_period_end_date: Time, - # current_billing_period_start_date: Time, - # end_date: Time, - # **_ - # } - # ``` class PriceInterval < Orb::BaseModel # @!attribute id # @@ -1355,14 +1201,6 @@ class PriceInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # fixed_fee_quantity_transition => { - # effective_date: Time, - # price_id: String, - # quantity: Integer - # } - # ``` class FixedFeeQuantityTransition < Orb::BaseModel # @!attribute effective_date # @@ -1390,14 +1228,6 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end - # @example - # ```ruby - # redeemed_coupon => { - # coupon_id: String, - # end_date: Time, - # start_date: Time - # } - # ``` class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1450,12 +1280,6 @@ class Status < Orb::Enum # def self.values; end end - # @example - # ```ruby - # trial_info => { - # end_date: Time - # } - # ``` class TrialInfo < Orb::BaseModel # @!attribute end_date # 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 502def73..209e6236 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 @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # subscription_unschedule_fixed_fee_quantity_updates_response => { - # id: String, - # active_plan_phase_order: Integer, - # adjustment_intervals: -> { Orb::ArrayOf[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval] === _1 }, - # auto_collection: Orb::BooleanModel, - # billing_cycle_anchor_configuration: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::BillingCycleAnchorConfiguration, - # **_ - # } - # ``` class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::BaseModel # @!attribute id # @@ -262,16 +251,6 @@ class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # adjustment_interval => { - # id: String, - # adjustment: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # start_date: Time - # } - # ``` class AdjustmentInterval < Orb::BaseModel # @!attribute id # @@ -321,7 +300,7 @@ class AdjustmentInterval < Orb::BaseModel # in { # adjustment_type: "usage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment ... @@ -329,27 +308,27 @@ class AdjustmentInterval < Orb::BaseModel # adjustment_type: "amount_discount", # id: String, # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment ... # in { # adjustment_type: "percentage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment ... # in { # adjustment_type: "minimum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment ... # in { # adjustment_type: "maximum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment ... @@ -389,17 +368,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment } - # @example - # ```ruby - # plan_phase_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # plan_phase_order: Integer, - # **_ - # } - # ``` class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -468,17 +436,6 @@ class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -547,17 +504,6 @@ class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # percentage_discount: Float, - # **_ - # } - # ``` class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -626,17 +572,6 @@ class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # item_id: String, - # **_ - # } - # ``` class PlanPhaseMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -713,17 +648,6 @@ class PlanPhaseMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # maximum_amount: String, - # **_ - # } - # ``` class PlanPhaseMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -794,14 +718,6 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_anchor_configuration => { - # day: Integer, - # month: Integer, - # year: Integer - # } - # ``` class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -845,21 +761,21 @@ class BillingCycleAnchorConfiguration < Orb::BaseModel # in { # discount_type: "amount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval ... # in { # discount_type: "percentage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval ... # in { # discount_type: "usage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval ... @@ -889,16 +805,6 @@ class DiscountInterval < Orb::Union variant :usage, -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval } - # @example - # ```ruby - # amount_discount_interval => { - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :amount, - # end_date: Time - # } - # ``` class AmountDiscountInterval < Orb::BaseModel # @!attribute amount_discount # Only available if discount_type is `amount`. @@ -958,16 +864,6 @@ class AmountDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # percentage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :percentage, - # end_date: Time, - # percentage_discount: Float - # } - # ``` class PercentageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1028,16 +924,6 @@ class PercentageDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # usage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :usage, - # end_date: Time, - # start_date: Time - # } - # ``` class UsageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1099,15 +985,6 @@ class UsageDiscountInterval < Orb::BaseModel end end - # @example - # ```ruby - # fixed_fee_quantity_schedule => { - # end_date: Time, - # price_id: String, - # quantity: Float, - # start_date: Time - # } - # ``` class FixedFeeQuantitySchedule < Orb::BaseModel # @!attribute end_date # @@ -1140,16 +1017,6 @@ class FixedFeeQuantitySchedule < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # maximum_amount: String, - # start_date: Time - # } - # ``` class MaximumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this maximum interval applies to. @@ -1194,16 +1061,6 @@ class MaximumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # minimum_amount: String, - # start_date: Time - # } - # ``` class MinimumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this minimum interval applies to. @@ -1248,17 +1105,6 @@ class MinimumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # price_interval => { - # id: String, - # billing_cycle_day: Integer, - # current_billing_period_end_date: Time, - # current_billing_period_start_date: Time, - # end_date: Time, - # **_ - # } - # ``` class PriceInterval < Orb::BaseModel # @!attribute id # @@ -1359,14 +1205,6 @@ class PriceInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # fixed_fee_quantity_transition => { - # effective_date: Time, - # price_id: String, - # quantity: Integer - # } - # ``` class FixedFeeQuantityTransition < Orb::BaseModel # @!attribute effective_date # @@ -1394,14 +1232,6 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end - # @example - # ```ruby - # redeemed_coupon => { - # coupon_id: String, - # end_date: Time, - # start_date: Time - # } - # ``` class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1454,12 +1284,6 @@ class Status < Orb::Enum # def self.values; end end - # @example - # ```ruby - # trial_info => { - # end_date: Time - # } - # ``` class TrialInfo < Orb::BaseModel # @!attribute end_date # 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 a43a0acd..12a376e1 100644 --- a/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +++ b/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # subscription_unschedule_pending_plan_changes_response => { - # id: String, - # active_plan_phase_order: Integer, - # adjustment_intervals: -> { Orb::ArrayOf[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval] === _1 }, - # auto_collection: Orb::BooleanModel, - # billing_cycle_anchor_configuration: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::BillingCycleAnchorConfiguration, - # **_ - # } - # ``` class SubscriptionUnschedulePendingPlanChangesResponse < Orb::BaseModel # @!attribute id # @@ -262,16 +251,6 @@ class SubscriptionUnschedulePendingPlanChangesResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # adjustment_interval => { - # id: String, - # adjustment: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # start_date: Time - # } - # ``` class AdjustmentInterval < Orb::BaseModel # @!attribute id # @@ -321,7 +300,7 @@ class AdjustmentInterval < Orb::BaseModel # in { # adjustment_type: "usage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment ... @@ -329,27 +308,27 @@ class AdjustmentInterval < Orb::BaseModel # adjustment_type: "amount_discount", # id: String, # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment ... # in { # adjustment_type: "percentage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment ... # in { # adjustment_type: "minimum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment ... # in { # adjustment_type: "maximum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment ... @@ -389,17 +368,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment } - # @example - # ```ruby - # plan_phase_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # plan_phase_order: Integer, - # **_ - # } - # ``` class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -468,17 +436,6 @@ class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -547,17 +504,6 @@ class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # percentage_discount: Float, - # **_ - # } - # ``` class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -626,17 +572,6 @@ class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # item_id: String, - # **_ - # } - # ``` class PlanPhaseMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -713,17 +648,6 @@ class PlanPhaseMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # maximum_amount: String, - # **_ - # } - # ``` class PlanPhaseMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -794,14 +718,6 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_anchor_configuration => { - # day: Integer, - # month: Integer, - # year: Integer - # } - # ``` class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -845,21 +761,21 @@ class BillingCycleAnchorConfiguration < Orb::BaseModel # in { # discount_type: "amount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval ... # in { # discount_type: "percentage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval ... # in { # discount_type: "usage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval ... @@ -889,16 +805,6 @@ class DiscountInterval < Orb::Union variant :usage, -> { Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval } - # @example - # ```ruby - # amount_discount_interval => { - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :amount, - # end_date: Time - # } - # ``` class AmountDiscountInterval < Orb::BaseModel # @!attribute amount_discount # Only available if discount_type is `amount`. @@ -958,16 +864,6 @@ class AmountDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # percentage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :percentage, - # end_date: Time, - # percentage_discount: Float - # } - # ``` class PercentageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1028,16 +924,6 @@ class PercentageDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # usage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :usage, - # end_date: Time, - # start_date: Time - # } - # ``` class UsageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1099,15 +985,6 @@ class UsageDiscountInterval < Orb::BaseModel end end - # @example - # ```ruby - # fixed_fee_quantity_schedule => { - # end_date: Time, - # price_id: String, - # quantity: Float, - # start_date: Time - # } - # ``` class FixedFeeQuantitySchedule < Orb::BaseModel # @!attribute end_date # @@ -1140,16 +1017,6 @@ class FixedFeeQuantitySchedule < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # maximum_amount: String, - # start_date: Time - # } - # ``` class MaximumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this maximum interval applies to. @@ -1194,16 +1061,6 @@ class MaximumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # minimum_amount: String, - # start_date: Time - # } - # ``` class MinimumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this minimum interval applies to. @@ -1248,17 +1105,6 @@ class MinimumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # price_interval => { - # id: String, - # billing_cycle_day: Integer, - # current_billing_period_end_date: Time, - # current_billing_period_start_date: Time, - # end_date: Time, - # **_ - # } - # ``` class PriceInterval < Orb::BaseModel # @!attribute id # @@ -1355,14 +1201,6 @@ class PriceInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # fixed_fee_quantity_transition => { - # effective_date: Time, - # price_id: String, - # quantity: Integer - # } - # ``` class FixedFeeQuantityTransition < Orb::BaseModel # @!attribute effective_date # @@ -1390,14 +1228,6 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end - # @example - # ```ruby - # redeemed_coupon => { - # coupon_id: String, - # end_date: Time, - # start_date: Time - # } - # ``` class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1450,12 +1280,6 @@ class Status < Orb::Enum # def self.values; end end - # @example - # ```ruby - # trial_info => { - # end_date: Time - # } - # ``` class TrialInfo < Orb::BaseModel # @!attribute end_date # 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 623c4e78..22745151 100644 --- a/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +++ b/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # subscription_update_fixed_fee_quantity_response => { - # id: String, - # active_plan_phase_order: Integer, - # adjustment_intervals: -> { Orb::ArrayOf[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval] === _1 }, - # auto_collection: Orb::BooleanModel, - # billing_cycle_anchor_configuration: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::BillingCycleAnchorConfiguration, - # **_ - # } - # ``` class SubscriptionUpdateFixedFeeQuantityResponse < Orb::BaseModel # @!attribute id # @@ -262,16 +251,6 @@ class SubscriptionUpdateFixedFeeQuantityResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # adjustment_interval => { - # id: String, - # adjustment: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # start_date: Time - # } - # ``` class AdjustmentInterval < Orb::BaseModel # @!attribute id # @@ -321,7 +300,7 @@ class AdjustmentInterval < Orb::BaseModel # in { # adjustment_type: "usage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment ... @@ -329,27 +308,27 @@ class AdjustmentInterval < Orb::BaseModel # adjustment_type: "amount_discount", # id: String, # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment ... # in { # adjustment_type: "percentage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment ... # in { # adjustment_type: "minimum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment ... # in { # adjustment_type: "maximum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment ... @@ -389,17 +368,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment } - # @example - # ```ruby - # plan_phase_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # plan_phase_order: Integer, - # **_ - # } - # ``` class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -468,17 +436,6 @@ class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -547,17 +504,6 @@ class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # percentage_discount: Float, - # **_ - # } - # ``` class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -626,17 +572,6 @@ class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # item_id: String, - # **_ - # } - # ``` class PlanPhaseMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -713,17 +648,6 @@ class PlanPhaseMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # maximum_amount: String, - # **_ - # } - # ``` class PlanPhaseMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -794,14 +718,6 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_anchor_configuration => { - # day: Integer, - # month: Integer, - # year: Integer - # } - # ``` class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -845,21 +761,21 @@ class BillingCycleAnchorConfiguration < Orb::BaseModel # in { # discount_type: "amount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::AmountDiscountInterval ... # in { # discount_type: "percentage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::PercentageDiscountInterval ... # in { # discount_type: "usage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::UsageDiscountInterval ... @@ -889,16 +805,6 @@ class DiscountInterval < Orb::Union variant :usage, -> { Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::UsageDiscountInterval } - # @example - # ```ruby - # amount_discount_interval => { - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :amount, - # end_date: Time - # } - # ``` class AmountDiscountInterval < Orb::BaseModel # @!attribute amount_discount # Only available if discount_type is `amount`. @@ -958,16 +864,6 @@ class AmountDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # percentage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :percentage, - # end_date: Time, - # percentage_discount: Float - # } - # ``` class PercentageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1028,16 +924,6 @@ class PercentageDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # usage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :usage, - # end_date: Time, - # start_date: Time - # } - # ``` class UsageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1099,15 +985,6 @@ class UsageDiscountInterval < Orb::BaseModel end end - # @example - # ```ruby - # fixed_fee_quantity_schedule => { - # end_date: Time, - # price_id: String, - # quantity: Float, - # start_date: Time - # } - # ``` class FixedFeeQuantitySchedule < Orb::BaseModel # @!attribute end_date # @@ -1140,16 +1017,6 @@ class FixedFeeQuantitySchedule < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # maximum_amount: String, - # start_date: Time - # } - # ``` class MaximumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this maximum interval applies to. @@ -1194,16 +1061,6 @@ class MaximumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # minimum_amount: String, - # start_date: Time - # } - # ``` class MinimumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this minimum interval applies to. @@ -1248,17 +1105,6 @@ class MinimumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # price_interval => { - # id: String, - # billing_cycle_day: Integer, - # current_billing_period_end_date: Time, - # current_billing_period_start_date: Time, - # end_date: Time, - # **_ - # } - # ``` class PriceInterval < Orb::BaseModel # @!attribute id # @@ -1355,14 +1201,6 @@ class PriceInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # fixed_fee_quantity_transition => { - # effective_date: Time, - # price_id: String, - # quantity: Integer - # } - # ``` class FixedFeeQuantityTransition < Orb::BaseModel # @!attribute effective_date # @@ -1390,14 +1228,6 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end - # @example - # ```ruby - # redeemed_coupon => { - # coupon_id: String, - # end_date: Time, - # start_date: Time - # } - # ``` class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1450,12 +1280,6 @@ class Status < Orb::Enum # def self.values; end end - # @example - # ```ruby - # trial_info => { - # end_date: Time - # } - # ``` class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_update_trial_response.rb b/lib/orb/models/subscription_update_trial_response.rb index 78ad3534..f75fe5f5 100644 --- a/lib/orb/models/subscription_update_trial_response.rb +++ b/lib/orb/models/subscription_update_trial_response.rb @@ -2,17 +2,6 @@ module Orb module Models - # @example - # ```ruby - # subscription_update_trial_response => { - # id: String, - # active_plan_phase_order: Integer, - # adjustment_intervals: -> { Orb::ArrayOf[Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval] === _1 }, - # auto_collection: Orb::BooleanModel, - # billing_cycle_anchor_configuration: Orb::Models::SubscriptionUpdateTrialResponse::BillingCycleAnchorConfiguration, - # **_ - # } - # ``` class SubscriptionUpdateTrialResponse < Orb::BaseModel # @!attribute id # @@ -260,16 +249,6 @@ class SubscriptionUpdateTrialResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # adjustment_interval => { - # id: String, - # adjustment: Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # start_date: Time - # } - # ``` class AdjustmentInterval < Orb::BaseModel # @!attribute id # @@ -319,7 +298,7 @@ class AdjustmentInterval < Orb::BaseModel # in { # adjustment_type: "usage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment ... @@ -327,27 +306,27 @@ class AdjustmentInterval < Orb::BaseModel # adjustment_type: "amount_discount", # id: String, # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment ... # in { # adjustment_type: "percentage_discount", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment ... # in { # adjustment_type: "minimum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment ... # in { # adjustment_type: "maximum", # id: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), # is_invoice_level: Orb::BooleanModel # } # # Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment ... @@ -387,17 +366,6 @@ class Adjustment < Orb::Union variant :maximum, -> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment } - # @example - # ```ruby - # plan_phase_usage_discount_adjustment => { - # id: String, - # adjustment_type: :usage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # plan_phase_order: Integer, - # **_ - # } - # ``` class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -466,17 +434,6 @@ class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_amount_discount_adjustment => { - # id: String, - # adjustment_type: :amount_discount, - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # **_ - # } - # ``` class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -545,17 +502,6 @@ class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_percentage_discount_adjustment => { - # id: String, - # adjustment_type: :percentage_discount, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # percentage_discount: Float, - # **_ - # } - # ``` class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # @!attribute id # @@ -624,17 +570,6 @@ class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_minimum_adjustment => { - # id: String, - # adjustment_type: :minimum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # item_id: String, - # **_ - # } - # ``` class PlanPhaseMinimumAdjustment < Orb::BaseModel # @!attribute id # @@ -711,17 +646,6 @@ class PlanPhaseMinimumAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # plan_phase_maximum_adjustment => { - # id: String, - # adjustment_type: :maximum, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # is_invoice_level: Orb::BooleanModel, - # maximum_amount: String, - # **_ - # } - # ``` class PlanPhaseMaximumAdjustment < Orb::BaseModel # @!attribute id # @@ -792,14 +716,6 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end - # @example - # ```ruby - # billing_cycle_anchor_configuration => { - # day: Integer, - # month: Integer, - # year: Integer - # } - # ``` class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -843,21 +759,21 @@ class BillingCycleAnchorConfiguration < Orb::BaseModel # in { # discount_type: "amount", # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 } + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]) # } # # Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval ... # in { # discount_type: "percentage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval ... # in { # discount_type: "usage", - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, + # applies_to_price_ids: ^(Orb::ArrayOf[String]), + # applies_to_price_interval_ids: ^(Orb::ArrayOf[String]), # end_date: Time # } # # Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval ... @@ -887,16 +803,6 @@ class DiscountInterval < Orb::Union variant :usage, -> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval } - # @example - # ```ruby - # amount_discount_interval => { - # amount_discount: String, - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :amount, - # end_date: Time - # } - # ``` class AmountDiscountInterval < Orb::BaseModel # @!attribute amount_discount # Only available if discount_type is `amount`. @@ -956,16 +862,6 @@ class AmountDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # percentage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :percentage, - # end_date: Time, - # percentage_discount: Float - # } - # ``` class PercentageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1026,16 +922,6 @@ class PercentageDiscountInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # usage_discount_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: :usage, - # end_date: Time, - # start_date: Time - # } - # ``` class UsageDiscountInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this discount interval applies to. @@ -1097,15 +983,6 @@ class UsageDiscountInterval < Orb::BaseModel end end - # @example - # ```ruby - # fixed_fee_quantity_schedule => { - # end_date: Time, - # price_id: String, - # quantity: Float, - # start_date: Time - # } - # ``` class FixedFeeQuantitySchedule < Orb::BaseModel # @!attribute end_date # @@ -1138,16 +1015,6 @@ class FixedFeeQuantitySchedule < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # maximum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # maximum_amount: String, - # start_date: Time - # } - # ``` class MaximumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this maximum interval applies to. @@ -1192,16 +1059,6 @@ class MaximumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # minimum_interval => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # applies_to_price_interval_ids: -> { Orb::ArrayOf[String] === _1 }, - # end_date: Time, - # minimum_amount: String, - # start_date: Time - # } - # ``` class MinimumInterval < Orb::BaseModel # @!attribute applies_to_price_ids # The price ids that this minimum interval applies to. @@ -1246,17 +1103,6 @@ class MinimumInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # price_interval => { - # id: String, - # billing_cycle_day: Integer, - # current_billing_period_end_date: Time, - # current_billing_period_start_date: Time, - # end_date: Time, - # **_ - # } - # ``` class PriceInterval < Orb::BaseModel # @!attribute id # @@ -1353,14 +1199,6 @@ class PriceInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # fixed_fee_quantity_transition => { - # effective_date: Time, - # price_id: String, - # quantity: Integer - # } - # ``` class FixedFeeQuantityTransition < Orb::BaseModel # @!attribute effective_date # @@ -1388,14 +1226,6 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end - # @example - # ```ruby - # redeemed_coupon => { - # coupon_id: String, - # end_date: Time, - # start_date: Time - # } - # ``` class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1448,12 +1278,6 @@ class Status < Orb::Enum # def self.values; end end - # @example - # ```ruby - # trial_info => { - # end_date: Time - # } - # ``` class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_usage.rb b/lib/orb/models/subscription_usage.rb index 78df4bfb..9c8fcc00 100644 --- a/lib/orb/models/subscription_usage.rb +++ b/lib/orb/models/subscription_usage.rb @@ -18,12 +18,6 @@ class SubscriptionUsage < Orb::Union variant -> { Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage } - # @example - # ```ruby - # ungrouped_subscription_usage => { - # data: -> { Orb::ArrayOf[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data] === _1 } - # } - # ``` class UngroupedSubscriptionUsage < Orb::BaseModel # @!attribute data # @@ -37,14 +31,6 @@ class UngroupedSubscriptionUsage < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # data => { - # billable_metric: Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric, - # usage: -> { Orb::ArrayOf[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage] === _1 }, - # view_mode: Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode - # } - # ``` class Data < Orb::BaseModel # @!attribute billable_metric # @@ -73,13 +59,6 @@ class Data < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String, - # name: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -100,14 +79,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # usage => { - # quantity: Float, - # timeframe_end: Time, - # timeframe_start: Time - # } - # ``` class Usage < Orb::BaseModel # @!attribute quantity # @@ -159,13 +130,6 @@ class ViewMode < Orb::Enum end end - # @example - # ```ruby - # grouped_subscription_usage => { - # data: -> { Orb::ArrayOf[Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data] === _1 }, - # pagination_metadata: Orb::Models::PaginationMetadata - # } - # ``` class GroupedSubscriptionUsage < Orb::BaseModel # @!attribute data # @@ -185,15 +149,6 @@ class GroupedSubscriptionUsage < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # data => { - # billable_metric: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric, - # metric_group: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup, - # usage: -> { Orb::ArrayOf[Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage] === _1 }, - # view_mode: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode - # } - # ``` class Data < Orb::BaseModel # @!attribute billable_metric # @@ -227,13 +182,6 @@ class Data < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void - # @example - # ```ruby - # billable_metric => { - # id: String, - # name: String - # } - # ``` class BillableMetric < Orb::BaseModel # @!attribute id # @@ -254,13 +202,6 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # metric_group => { - # property_key: String, - # property_value: String - # } - # ``` class MetricGroup < Orb::BaseModel # @!attribute property_key # @@ -281,14 +222,6 @@ class MetricGroup < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end - # @example - # ```ruby - # usage => { - # quantity: Float, - # timeframe_end: Time, - # timeframe_start: Time - # } - # ``` class Usage < Orb::BaseModel # @!attribute quantity # diff --git a/lib/orb/models/subscriptions.rb b/lib/orb/models/subscriptions.rb index 331e2c55..e6957180 100644 --- a/lib/orb/models/subscriptions.rb +++ b/lib/orb/models/subscriptions.rb @@ -2,13 +2,6 @@ module Orb module Models - # @example - # ```ruby - # subscriptions_api => { - # data: -> { Orb::ArrayOf[Orb::Models::Subscription] === _1 }, - # pagination_metadata: Orb::Models::PaginationMetadata - # } - # ``` class SubscriptionsAPI < Orb::BaseModel # @!attribute data # diff --git a/lib/orb/models/top_level_ping_response.rb b/lib/orb/models/top_level_ping_response.rb index ab91c197..55e06014 100644 --- a/lib/orb/models/top_level_ping_response.rb +++ b/lib/orb/models/top_level_ping_response.rb @@ -2,12 +2,6 @@ module Orb module Models - # @example - # ```ruby - # top_level_ping_response => { - # response: String - # } - # ``` class TopLevelPingResponse < Orb::BaseModel # @!attribute response # diff --git a/lib/orb/models/trial_discount.rb b/lib/orb/models/trial_discount.rb index ebbada0c..8bc5ab0f 100644 --- a/lib/orb/models/trial_discount.rb +++ b/lib/orb/models/trial_discount.rb @@ -2,16 +2,6 @@ module Orb module Models - # @example - # ```ruby - # trial_discount => { - # applies_to_price_ids: -> { Orb::ArrayOf[String] === _1 }, - # discount_type: Orb::Models::TrialDiscount::DiscountType, - # reason: String, - # trial_amount_discount: String, - # trial_percentage_discount: Float - # } - # ``` class TrialDiscount < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this discount applies to. For plan/plan phase discounts, diff --git a/lib/orb/page.rb b/lib/orb/page.rb index eb46bc87..ae265f49 100644 --- a/lib/orb/page.rb +++ b/lib/orb/page.rb @@ -35,7 +35,7 @@ class Page # # @param client [Orb::BaseClient] # @param req [Hash{Symbol=>Object}] - # @param headers [Hash{String=>String}] + # @param headers [Hash{String=>String}, Net::HTTPHeader] # @param unwrapped [Hash{Symbol=>Object}] # def initialize(client:, req:, headers:, unwrapped:) @@ -95,13 +95,6 @@ def inspect "#<#{self.class}:0x#{object_id.to_s(16)} data=#{data.inspect} pagination_metadata=#{pagination_metadata.inspect}>" end - # @example - # ```ruby - # pagination_metadata => { - # has_more: Orb::BooleanModel, - # next_cursor: String - # } - # ``` class PaginationMetadata < Orb::BaseModel # @!attribute has_more # diff --git a/lib/orb/pooled_net_requester.rb b/lib/orb/pooled_net_requester.rb index 4e9583a6..ada984d8 100644 --- a/lib/orb/pooled_net_requester.rb +++ b/lib/orb/pooled_net_requester.rb @@ -4,122 +4,160 @@ module Orb # @private # class PooledNetRequester - def initialize - @mutex = Mutex.new - @pools = {} + class << self + # @private + # + # @param url [URI::Generic] + # + # @return [Net::HTTP] + # + def connect(url) + port = + case [url.port, url.scheme] + in [Integer, _] + url.port + in [nil, "http" | "ws"] + Net::HTTP.http_default_port + in [nil, "https" | "wss"] + Net::HTTP.https_default_port + end + + Net::HTTP.new(url.host, port).tap do + _1.use_ssl = %w[https wss].include?(url.scheme) + _1.max_retries = 0 + end + end + + # @private + # + # @param conn [Net::HTTP] + # @param deadline [Float] + # + private def calibrate_socket_timeout(conn, deadline) + timeout = deadline - Orb::Util.monotonic_secs + conn.read_timeout = conn.write_timeout = conn.continue_timeout = timeout + end + + # @private + # + # @param conn [Net::HTTP] + # @param req [Net::HTTPGenericRequest] + # @param deadline [Float] + # @param blk [Proc] + # + def transport(conn, req, deadline, &blk) + unless conn.started? + conn.open_timeout = deadline - Orb::Util.monotonic_secs + conn.start + end + + calibrate_socket_timeout(conn, deadline) + conn.request(req) do |rsp| + blk.call(rsp) + rsp.read_body do |bytes| + blk.call(bytes) + calibrate_socket_timeout(conn, deadline) + end + end + end end # @private # - # @param url [URL::Generic] + # @param url [URI::Generic] + # @param streaming [Boolean] # @param blk [Proc] # - # @return [ConnectionPool] - # - private def with_pool(url, &blk) + private def with_pool(url, streaming:, &blk) origin = Orb::Util.uri_origin(url) - key = :"#{self.class.name}-connection_in_use_for_#{origin}" + th = Thread.current + key = :"#{object_id}-#{self.class.name}-connection_in_use_for_#{origin}" - return blk.call(make_conn(url)) if Thread.current[key] + if th[key] || streaming + return Enumerator.new do |y| + conn = self.class.connect(url) + blk.call(conn, y) + end + end pool = @mutex.synchronize do @pools[origin] ||= ConnectionPool.new(size: Etc.nprocessors) do - make_conn(url) + self.class.connect(url) end end - pool.with do |conn| - Thread.current[key] = true - - blk.call(conn) - # rubocop:disable Lint/RescueException - rescue Exception => e - # rubocop:enable Lint/RescueException - # should close connection on all errors to ensure no invalid state persists - conn.finish if conn.started? - raise e - ensure - Thread.current[key] = nil + Enumerator.new do |y| + pool.with do |conn| + th[key] = true + + blk.call(conn, y) + # rubocop:disable Lint/RescueException + rescue Exception => e + # rubocop:enable Lint/RescueException + # should close connection on all errors to ensure no invalid state persists + conn.finish if conn.started? + raise e + ensure + th[key] = nil + end end end # @private # - # @param url [URI::Generic] + # @param request [Hash{Symbol=>Object}] . # - # @return [Net::HTTP] + # @option request [Symbol] :method # - private def make_conn(url) - port = - case [url.port, url.scheme] - in [Integer, _] - url.port - in [nil, "http" | "ws"] - Net::HTTP.http_default_port - in [nil, "https" | "wss"] - Net::HTTP.https_default_port - end - - Net::HTTP.new(url.host, port).tap do - _1.use_ssl = %w[https wss].include?(url.scheme) - _1.max_retries = 0 - end - end - - # @private + # @option request [URI::Generic] :url + # + # @option request [Hash{String=>String}] :headers # - # @param req [Hash{Symbol => Object}] - # @option req [Symbol] :method - # @option req [URI::Generic] :url - # @option req [Hash{String => String}] :headers - # @option req [String, Hash, IO, StringIO] :body - # @option req [Float] :timeout + # @option request [Object] :body # - # @return [Net::HTTPResponse] + # @option request [Boolean] :streaming # - def execute(req) - method, url, headers, body, timeout = req.fetch_values(:method, :url, :headers, :body, :timeout) + # @option request [Integer] :max_retries + # + # @option request [Float] :deadline + # + # @return [Array(Net::HTTPResponse, Enumerable)] + # + def execute(request) + method, url, headers, body, deadline = request.fetch_values(:method, :url, :headers, :body, :deadline) + streaming = request.fetch(:streaming) - request = Net::HTTPGenericRequest.new( + req = Net::HTTPGenericRequest.new( method.to_s.upcase, !body.nil?, method != :head, url.to_s ) - headers.each { |k, v| request[k] = v } + headers.each { req[_1] = _2 } case body - in String | nil - request.body = body + in nil + in String + req.body = body in IO | StringIO - request.body_stream = body - end - - with_pool(url) do |conn| - make_request(conn, request, timeout) + body.rewind + req.body_stream = body end - end - # @private - # - # @param conn [Net::HTTP] - # @param request [Net::HTTPGenericRequest] - # @param timeout [Float] - # - # @return [Net::HTTPResponse] - # - private def make_request(conn, request, timeout) - unless conn.started? - conn.open_timeout = timeout - conn.start - end + enum = + with_pool(url, streaming: streaming) do |conn, y| + self.class.transport(conn, req, deadline, &y) + end - conn.read_timeout = timeout - conn.write_timeout = timeout - conn.continue_timeout = timeout + enum = streaming ? enum.lazy : enum.to_a + response = enum.take(1).first + [response, (response.body = enum.drop(1))] + end - conn.request(request) + def initialize + @mutex = Mutex.new + @pools = {} end end end diff --git a/lib/orb/resources/prices.rb b/lib/orb/resources/prices.rb index aa3d9f16..96da7cc2 100644 --- a/lib/orb/resources/prices.rb +++ b/lib/orb/resources/prices.rb @@ -23,7 +23,7 @@ class Prices # # @option params [String] :currency An ISO 4217 currency string for which this price is billed in. # - # @option params [String] :item_id The id of the item the plan will be associated with. + # @option params [String] :item_id The id of the item the price will be associated with. # # @option params [Symbol, Orb::Models::PriceCreateParams::ModelType] :model_type # diff --git a/lib/orb/resources/subscriptions.rb b/lib/orb/resources/subscriptions.rb index e000f7e5..61695d38 100644 --- a/lib/orb/resources/subscriptions.rb +++ b/lib/orb/resources/subscriptions.rb @@ -1048,9 +1048,9 @@ def price_intervals(subscription_id, params = {}) # `plan_phase_order` key to indicate which phase the price should be added to. # # An object in the list can specify an optional `start_date` and optional - # `end_date`. This is equivalent to creating a price interval with the - # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). - # If unspecified, the start or end date of the phase or subscription will be used. + # `end_date`. If `start_date` is unspecified, the start of the phase / plan change + # time will be used. If `end_date` is unspecified, it will finish at the end of + # the phase / have no end time. # # An object in the list can specify an optional `minimum_amount`, # `maximum_amount`, or `discounts`. This will create adjustments which apply only @@ -1109,8 +1109,9 @@ def price_intervals(subscription_id, params = {}) # to. # # An object in the list can specify an optional `start_date` and optional - # `end_date`. If unspecified, the start or end date of the phase or subscription - # will be used. + # `end_date`. If `start_date` is unspecified, the start of the phase / plan change + # time will be used. If `end_date` is unspecified, it will finish at the end of + # the phase / have no end time. # # ### Removing adjustments # diff --git a/lib/orb/util.rb b/lib/orb/util.rb index 893860d5..6b76022c 100644 --- a/lib/orb/util.rb +++ b/lib/orb/util.rb @@ -105,6 +105,12 @@ def self.coerce_hash(input) end end + # @private + # + # @return [Float] + # + def self.monotonic_secs = Process.clock_gettime(Process::CLOCK_MONOTONIC) + # @private # # @param exceptions [Array] @@ -384,6 +390,11 @@ def self.encode_content(headers, body) "transfer-encoding" => "chunked" } [headers, strio] + in [_, StringIO] + [headers, body.string] + in [_, IO] + headers = {**headers, "transfer-encoding" => "chunked"} + [headers, body] else [headers, body] end @@ -391,24 +402,28 @@ def self.encode_content(headers, body) # @private # - # @param response [Net::HTTPResponse] + # @param headers [Hash{String=>String}, Net::HTTPHeader] + # @param stream [Enumerable] # @param suppress_error [Boolean] # # @raise [JSON::ParserError] # @return [Object] # - def self.decode_content(response, suppress_error: false) - case response.content_type - in "application/json" + def self.decode_content(headers, stream:, suppress_error: false) + case headers["content-type"] + in %r{^application/json} + json = stream.to_a.join("") begin - JSON.parse(response.body, symbolize_names: true) + JSON.parse(json, symbolize_names: true) rescue JSON::ParserError => e raise e unless suppress_error - response.body + json end + in %r{^text/} + stream.to_a.join("") else # TODO: parsing other response types - response.body + StringIO.new(stream.to_a.join("")) end end diff --git a/lib/orb/version.rb b/lib/orb/version.rb index 1867824a..67d01d88 100644 --- a/lib/orb/version.rb +++ b/lib/orb/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Orb - VERSION = "0.1.0-alpha.10" + VERSION = "0.1.0-alpha.11" end diff --git a/orb.gemspec b/orb.gemspec index bae6ea39..e24503ff 100644 --- a/orb.gemspec +++ b/orb.gemspec @@ -15,5 +15,5 @@ Gem::Specification.new do |s| s.homepage = "https://gemdocs.org/gems/orb/latest" s.metadata["homepage_uri"] = s.homepage s.metadata["source_code_uri"] = "https://github.com/orbcorp/orb-ruby" - s.metadata["rubygems_mfa_required"] = "true" + s.metadata["rubygems_mfa_required"] = "false" end diff --git a/rbi/lib/orb/base_client.rbi b/rbi/lib/orb/base_client.rbi index 726bd5b9..a1bd4211 100644 --- a/rbi/lib/orb/base_client.rbi +++ b/rbi/lib/orb/base_client.rbi @@ -24,6 +24,7 @@ module Orb url: URI::Generic, headers: T::Hash[String, String], body: T.anything, + streaming: T::Boolean, max_retries: Integer, timeout: Float } @@ -35,6 +36,23 @@ module Orb def self.validate!(req) end + sig do + params(status: Integer, headers: T.any(T::Hash[String, String], Net::HTTPHeader)).returns(T::Boolean) + end + def self.should_retry?(status, headers:) + end + + sig do + params( + request: Orb::BaseClient::RequestInputShape, + status: Integer, + response_headers: T.any(T::Hash[String, String], Net::HTTPHeader) + ) + .returns(Orb::BaseClient::RequestInputShape) + end + def self.follow_redirect(request, status:, response_headers:) + end + sig { returns(T.anything) } def requester end @@ -75,27 +93,17 @@ module Orb end sig do - params(req: Orb::BaseClient::RequestComponentsShape, opts: T::Hash[Symbol, T.anything]) + overridable + .params(req: Orb::BaseClient::RequestComponentsShape, opts: T::Hash[Symbol, T.anything]) .returns(Orb::BaseClient::RequestInputShape) end private def build_request(req, opts) end - sig { params(status: Integer, headers: T::Hash[String, String]).returns(T::Boolean) } - private def should_retry?(status, headers:) - end - sig { params(headers: T::Hash[String, String], retry_count: Integer).returns(Float) } private def retry_delay(headers, retry_count:) end - sig do - params(request: Orb::BaseClient::RequestInputShape, status: Integer, location_header: String) - .returns(Orb::BaseClient::RequestInputShape) - end - private def follow_redirect(request, status:, location_header:) - end - sig do params( request: Orb::BaseClient::RequestInputShape, @@ -103,13 +111,20 @@ module Orb retry_count: Integer, send_retry_header: T::Boolean ) - .returns(Net::HTTPResponse) + .returns([Net::HTTPResponse, T::Enumerable[String]]) end private def send_request(request, redirect_count:, retry_count:, send_retry_header:) end - sig { params(req: Orb::BaseClient::RequestComponentsShape, response: NilClass).returns(T.anything) } - private def parse_response(req, response) + sig do + params( + req: Orb::BaseClient::RequestComponentsShape, + headers: T.any(T::Hash[String, String], Net::HTTPHeader), + stream: T::Enumerable[String] + ) + .returns(T.anything) + end + private def parse_response(req, headers:, stream:) end sig do diff --git a/rbi/lib/orb/base_page.rbi b/rbi/lib/orb/base_page.rbi index 977f31d9..4410d232 100644 --- a/rbi/lib/orb/base_page.rbi +++ b/rbi/lib/orb/base_page.rbi @@ -28,7 +28,7 @@ module Orb params( client: Orb::BaseClient, req: Orb::BaseClient::RequestComponentsShape, - headers: T::Hash[String, String], + headers: T.any(T::Hash[String, String], Net::HTTPHeader), unwrapped: T.anything ) .void diff --git a/rbi/lib/orb/models/credit_note.rbi b/rbi/lib/orb/models/credit_note.rbi index 0333d001..f643a80c 100644 --- a/rbi/lib/orb/models/credit_note.rbi +++ b/rbi/lib/orb/models/credit_note.rbi @@ -248,6 +248,14 @@ module Orb def amount=(_) end + sig { returns(String) } + def item_id + end + + sig { params(_: String).returns(String) } + def item_id=(_) + end + sig { returns(String) } def name end @@ -298,6 +306,7 @@ module Orb params( id: String, amount: String, + item_id: String, name: String, quantity: T.nilable(Float), subtotal: String, @@ -306,7 +315,7 @@ module Orb ) .void end - def initialize(id:, amount:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil) + def initialize(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil) end sig do @@ -315,6 +324,7 @@ module Orb { id: String, amount: String, + item_id: String, name: String, quantity: T.nilable(Float), subtotal: String, diff --git a/rbi/lib/orb/page.rbi b/rbi/lib/orb/page.rbi index 24c45dd8..d335946d 100644 --- a/rbi/lib/orb/page.rbi +++ b/rbi/lib/orb/page.rbi @@ -26,7 +26,7 @@ module Orb params( client: Orb::BaseClient, req: Orb::BaseClient::RequestComponentsShape, - headers: T::Hash[String, String], + headers: T.any(T::Hash[String, String], Net::HTTPHeader), unwrapped: T::Hash[Symbol, T.anything] ) .void diff --git a/rbi/lib/orb/pooled_net_requester.rbi b/rbi/lib/orb/pooled_net_requester.rbi new file mode 100644 index 00000000..e5538507 --- /dev/null +++ b/rbi/lib/orb/pooled_net_requester.rbi @@ -0,0 +1,63 @@ +# typed: strong + +module Orb + class PooledNetRequester + RequestShape = T.type_alias do + { + method: Symbol, + url: URI::Generic, + headers: T::Hash[String, String], + body: T.anything, + streaming: T::Boolean, + max_retries: Integer, + deadline: Float + } + end + + sig { params(url: URI::Generic).returns(Net::HTTP) } + def self.connect(url) + end + + sig { params(conn: Net::HTTP, deadline: Float).void } + private_class_method def self.calibrate_socket_timeout(conn, deadline) + end + + sig do + params( + conn: Net::HTTP, + req: Net::HTTPGenericRequest, + deadline: Float, + blk: T.proc.params(arg0: T.any(Net::HTTPGenericRequest, String)).void + ) + .void + end + def self.transport(conn, req, deadline, &blk) + end + + sig do + params( + url: URI::Generic, + streaming: T::Boolean, + blk: T.proc.params(arg0: Net::HTTP, arg1: Enumerator::Yielder).void + ) + .void + end + private def with_pool(url, streaming:, &blk) + end + + sig do + params(request: Orb::PooledNetRequester::RequestShape).returns( + [ + Net::HTTPResponse, + T::Enumerable[String] + ] + ) + end + def execute(request) + end + + sig { void } + def initialize + end + end +end diff --git a/rbi/lib/orb/util.rbi b/rbi/lib/orb/util.rbi index 5e86301a..7defb83e 100644 --- a/rbi/lib/orb/util.rbi +++ b/rbi/lib/orb/util.rbi @@ -26,6 +26,10 @@ module Orb def self.coerce_hash(input) end + sig { returns(Float) } + def self.monotonic_secs + end + sig do params( exceptions: T::Array[Exception], @@ -110,8 +114,15 @@ module Orb def self.encode_content(headers, body) end - sig { params(response: Net::HTTPResponse, suppress_error: T::Boolean).returns(T.anything) } - def self.decode_content(response, suppress_error: false) + sig do + params( + headers: T.any(T::Hash[String, String], Net::HTTPHeader), + stream: T::Enumerable[String], + suppress_error: T::Boolean + ) + .returns(T.anything) + end + def self.decode_content(headers, stream:, suppress_error: false) end sig { params(io: StringIO, boundary: String, key: T.any(Symbol, String), val: T.anything).void } diff --git a/rbi/lib/orb/version.rbi b/rbi/lib/orb/version.rbi index a2fa65c0..6b332147 100644 --- a/rbi/lib/orb/version.rbi +++ b/rbi/lib/orb/version.rbi @@ -1,5 +1,5 @@ # typed: strong module Orb - VERSION = "0.1.0-alpha.10" + VERSION = "0.1.0-alpha.11" end diff --git a/sig/orb/base_client.rbs b/sig/orb/base_client.rbs index 07107b0f..7bc42dc6 100644 --- a/sig/orb/base_client.rbs +++ b/sig/orb/base_client.rbs @@ -19,6 +19,7 @@ module Orb url: URI::Generic, headers: ::Hash[String, String], body: top, + streaming: bool, max_retries: Integer, timeout: Float } @@ -27,6 +28,17 @@ module Orb def self.validate!: (Orb::BaseClient::request_components req) -> void + def self.should_retry?: ( + Integer status, + headers: ::Hash[String, String] + ) -> bool + + def self.follow_redirect: ( + Orb::BaseClient::request_input request, + status: Integer, + response_headers: ::Hash[String, String] + ) -> Orb::BaseClient::request_input + # @private attr_accessor requester: top @@ -49,32 +61,22 @@ module Orb Orb::request_options opts ) -> Orb::BaseClient::request_input - private def should_retry?: ( - Integer status, - headers: ::Hash[String, String] - ) -> bool - private def retry_delay: ( ::Hash[String, String] headers, retry_count: Integer ) -> Float - private def follow_redirect: ( - Orb::BaseClient::request_input request, - status: Integer, - location_header: String - ) -> Orb::BaseClient::request_input - private def send_request: ( Orb::BaseClient::request_input request, redirect_count: Integer, retry_count: Integer, send_retry_header: bool - ) -> top + ) -> [top, Enumerable[String]] private def parse_response: ( Orb::BaseClient::request_components req, - nil response + headers: ::Hash[String, String], + stream: Enumerable[String] ) -> top def request: diff --git a/sig/orb/models/credit_note.rbs b/sig/orb/models/credit_note.rbs index b88ff8c3..32ade134 100644 --- a/sig/orb/models/credit_note.rbs +++ b/sig/orb/models/credit_note.rbs @@ -98,6 +98,7 @@ module Orb { id: String, amount: String, + item_id: String, name: String, quantity: Float?, subtotal: String, @@ -110,6 +111,8 @@ module Orb attr_accessor amount: String + attr_accessor item_id: String + attr_accessor name: String attr_accessor quantity: Float? @@ -128,6 +131,7 @@ module Orb ( id: String, amount: String, + item_id: String, name: String, quantity: Float?, subtotal: String, diff --git a/sig/orb/pooled_net_requester.rbs b/sig/orb/pooled_net_requester.rbs new file mode 100644 index 00000000..59271c61 --- /dev/null +++ b/sig/orb/pooled_net_requester.rbs @@ -0,0 +1,42 @@ +module Orb + class PooledNetRequester + type request = + { + method: Symbol, + url: URI::Generic, + headers: ::Hash[String, String], + body: top, + streaming: bool, + max_retries: Integer, + deadline: Float + } + + def self.connect: (URI::Generic url) -> top + + private def self.calibrate_socket_timeout: ( + top conn, + Float deadline + ) -> void + + def self.transport: ( + top conn, + top req, + Float deadline + ) { + (top | String arg0) -> void + } -> void + + private def with_pool: ( + URI::Generic url, + streaming: bool + ) { + (top arg0, Enumerator::Yielder arg1) -> void + } -> void + + def execute: ( + Orb::PooledNetRequester::request request + ) -> [top, Enumerable[String]] + + def initialize: -> void + end +end diff --git a/sig/orb/util.rbs b/sig/orb/util.rbs index 0034fca6..991fd9a6 100644 --- a/sig/orb/util.rbs +++ b/sig/orb/util.rbs @@ -12,6 +12,8 @@ module Orb def self?.coerce_hash: (top input) -> (::Hash[top, top] | top) + def self?.monotonic_secs: -> Float + def self?.suppress: ( *::Array[Exception] exceptions, sentinel: top? @@ -69,7 +71,11 @@ module Orb def self?.encode_content: (::Hash[String, String] headers, top body) -> top - def self?.decode_content: (top response, suppress_error: bool) -> top + def self?.decode_content: ( + ::Hash[String, String] headers, + stream: Enumerable[String], + suppress_error: bool + ) -> top def self?.encode_multipart_formdata: ( StringIO io, diff --git a/sig/orb/version.rbs b/sig/orb/version.rbs index d3c88ab2..a1234e1a 100644 --- a/sig/orb/version.rbs +++ b/sig/orb/version.rbs @@ -1,3 +1,3 @@ module Orb - VERSION: "0.1.0-alpha.9" + VERSION: "0.1.0-alpha.10" end diff --git a/test/orb/client_test.rb b/test/orb/client_test.rb index 32cda714..603f1f4b 100644 --- a/test/orb/client_test.rb +++ b/test/orb/client_test.rb @@ -20,23 +20,14 @@ def test_raises_on_missing_non_nullable_opts class MockResponse # @return [Integer] - attr_accessor :code - - # @return [String] - attr_accessor :content_type - - # @return [String] - attr_accessor :body + attr_reader :code # @param code [Integer] # @param headers [Hash{String=>String}] - # @param data [Object] # - def initialize(code, headers, data) + def initialize(code, headers) @code = code - @headers = headers - @content_type = "application/json" - @body = JSON.generate(data) + @headers = {"content-type" => "application/json", **headers} end # @param header [String] @@ -58,13 +49,13 @@ def key?(header) class MockRequester # @return [Integer] - attr_accessor :response_code + attr_reader :response_code # @return [Hash{String=>String}] - attr_accessor :response_headers + attr_reader :response_headers # @return [Object] - attr_accessor :response_data + attr_reader :response_data # @return [ArrayObject}>] attr_accessor :attempts @@ -76,7 +67,7 @@ class MockRequester def initialize(response_code, response_headers, response_data) @response_code = response_code @response_headers = response_headers - @response_data = response_data + @response_data = JSON.fast_generate(response_data) @attempts = [] end @@ -85,7 +76,7 @@ def initialize(response_code, response_headers, response_data) def execute(req) # Deep copy the request because it is mutated on each retry. attempts.push(Marshal.load(Marshal.dump(req))) - MockResponse.new(response_code, response_headers, response_data) + [MockResponse.new(response_code, response_headers), response_data.grapheme_clusters] end end diff --git a/test/orb/resources/alerts_test.rb b/test/orb/resources/alerts_test.rb index f96c2980..ccfc0a28 100644 --- a/test/orb/resources/alerts_test.rb +++ b/test/orb/resources/alerts_test.rb @@ -16,6 +16,21 @@ def test_retrieve assert_pattern do response => Orb::Models::Alert end + + assert_pattern do + response => { + id: String, + created_at: Time, + currency: String | nil, + customer: Orb::Models::Alert::Customer | nil, + enabled: Orb::BooleanModel, + metric: Orb::Models::Alert::Metric | nil, + plan: Orb::Models::Alert::Plan | nil, + subscription: Orb::Models::Alert::Subscription | nil, + thresholds: ^(Orb::ArrayOf[Orb::Models::Alert::Threshold]) | nil, + type: Orb::Models::Alert::Type + } + end end def test_update_required_params @@ -24,6 +39,21 @@ def test_update_required_params assert_pattern do response => Orb::Models::Alert end + + assert_pattern do + response => { + id: String, + created_at: Time, + currency: String | nil, + customer: Orb::Models::Alert::Customer | nil, + enabled: Orb::BooleanModel, + metric: Orb::Models::Alert::Metric | nil, + plan: Orb::Models::Alert::Plan | nil, + subscription: Orb::Models::Alert::Subscription | nil, + thresholds: ^(Orb::ArrayOf[Orb::Models::Alert::Threshold]) | nil, + type: Orb::Models::Alert::Type + } + end end def test_list @@ -44,6 +74,21 @@ def test_list assert_pattern do row => Orb::Models::Alert end + + assert_pattern do + row => { + id: String, + created_at: Time, + currency: String | nil, + customer: Orb::Models::Alert::Customer | nil, + enabled: Orb::BooleanModel, + metric: Orb::Models::Alert::Metric | nil, + plan: Orb::Models::Alert::Plan | nil, + subscription: Orb::Models::Alert::Subscription | nil, + thresholds: ^(Orb::ArrayOf[Orb::Models::Alert::Threshold]) | nil, + type: Orb::Models::Alert::Type + } + end end def test_create_for_customer_required_params @@ -52,6 +97,21 @@ def test_create_for_customer_required_params assert_pattern do response => Orb::Models::Alert end + + assert_pattern do + response => { + id: String, + created_at: Time, + currency: String | nil, + customer: Orb::Models::Alert::Customer | nil, + enabled: Orb::BooleanModel, + metric: Orb::Models::Alert::Metric | nil, + plan: Orb::Models::Alert::Plan | nil, + subscription: Orb::Models::Alert::Subscription | nil, + thresholds: ^(Orb::ArrayOf[Orb::Models::Alert::Threshold]) | nil, + type: Orb::Models::Alert::Type + } + end end def test_create_for_external_customer_required_params @@ -64,6 +124,21 @@ def test_create_for_external_customer_required_params assert_pattern do response => Orb::Models::Alert end + + assert_pattern do + response => { + id: String, + created_at: Time, + currency: String | nil, + customer: Orb::Models::Alert::Customer | nil, + enabled: Orb::BooleanModel, + metric: Orb::Models::Alert::Metric | nil, + plan: Orb::Models::Alert::Plan | nil, + subscription: Orb::Models::Alert::Subscription | nil, + thresholds: ^(Orb::ArrayOf[Orb::Models::Alert::Threshold]) | nil, + type: Orb::Models::Alert::Type + } + end end def test_create_for_subscription_required_params @@ -76,6 +151,21 @@ def test_create_for_subscription_required_params assert_pattern do response => Orb::Models::Alert end + + assert_pattern do + response => { + id: String, + created_at: Time, + currency: String | nil, + customer: Orb::Models::Alert::Customer | nil, + enabled: Orb::BooleanModel, + metric: Orb::Models::Alert::Metric | nil, + plan: Orb::Models::Alert::Plan | nil, + subscription: Orb::Models::Alert::Subscription | nil, + thresholds: ^(Orb::ArrayOf[Orb::Models::Alert::Threshold]) | nil, + type: Orb::Models::Alert::Type + } + end end def test_disable @@ -84,6 +174,21 @@ def test_disable assert_pattern do response => Orb::Models::Alert end + + assert_pattern do + response => { + id: String, + created_at: Time, + currency: String | nil, + customer: Orb::Models::Alert::Customer | nil, + enabled: Orb::BooleanModel, + metric: Orb::Models::Alert::Metric | nil, + plan: Orb::Models::Alert::Plan | nil, + subscription: Orb::Models::Alert::Subscription | nil, + thresholds: ^(Orb::ArrayOf[Orb::Models::Alert::Threshold]) | nil, + type: Orb::Models::Alert::Type + } + end end def test_enable @@ -92,5 +197,20 @@ def test_enable assert_pattern do response => Orb::Models::Alert end + + assert_pattern do + response => { + id: String, + created_at: Time, + currency: String | nil, + customer: Orb::Models::Alert::Customer | nil, + enabled: Orb::BooleanModel, + metric: Orb::Models::Alert::Metric | nil, + plan: Orb::Models::Alert::Plan | nil, + subscription: Orb::Models::Alert::Subscription | nil, + thresholds: ^(Orb::ArrayOf[Orb::Models::Alert::Threshold]) | nil, + type: Orb::Models::Alert::Type + } + end end end diff --git a/test/orb/resources/coupons/subscriptions_test.rb b/test/orb/resources/coupons/subscriptions_test.rb index 431d3997..8a4a3898 100644 --- a/test/orb/resources/coupons/subscriptions_test.rb +++ b/test/orb/resources/coupons/subscriptions_test.rb @@ -26,5 +26,35 @@ def test_list assert_pattern do row => Orb::Models::Subscription end + + assert_pattern do + row => { + id: String, + active_plan_phase_order: Integer | nil, + adjustment_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::AdjustmentInterval]), + auto_collection: Orb::BooleanModel | nil, + billing_cycle_anchor_configuration: Orb::Models::Subscription::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time | nil, + current_billing_period_start_date: Time | nil, + customer: Orb::Models::Customer, + default_invoice_memo: String | nil, + discount_intervals: ^(Orb::ArrayOf[union: Orb::Models::Subscription::DiscountInterval]), + end_date: Time | nil, + fixed_fee_quantity_schedule: ^(Orb::ArrayOf[Orb::Models::Subscription::FixedFeeQuantitySchedule]), + invoicing_threshold: String | nil, + maximum_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::MaximumInterval]), + metadata: ^(Orb::HashOf[String]), + minimum_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::MinimumInterval]), + net_terms: Integer, + plan: Orb::Models::Plan, + price_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::PriceInterval]), + redeemed_coupon: Orb::Models::Subscription::RedeemedCoupon | nil, + start_date: Time, + status: Orb::Models::Subscription::Status, + trial_info: Orb::Models::Subscription::TrialInfo + } + end end end diff --git a/test/orb/resources/coupons_test.rb b/test/orb/resources/coupons_test.rb index eb703ec4..071f9e46 100644 --- a/test/orb/resources/coupons_test.rb +++ b/test/orb/resources/coupons_test.rb @@ -19,6 +19,18 @@ def test_create_required_params assert_pattern do response => Orb::Models::Coupon end + + assert_pattern do + response => { + id: String, + archived_at: Time | nil, + discount: Orb::Models::Coupon::Discount, + duration_in_months: Integer | nil, + max_redemptions: Integer | nil, + redemption_code: String, + times_redeemed: Integer + } + end end def test_list @@ -37,6 +49,18 @@ def test_list assert_pattern do row => Orb::Models::Coupon end + + assert_pattern do + row => { + id: String, + archived_at: Time | nil, + discount: Orb::Models::Coupon::Discount, + duration_in_months: Integer | nil, + max_redemptions: Integer | nil, + redemption_code: String, + times_redeemed: Integer + } + end end def test_archive @@ -45,6 +69,18 @@ def test_archive assert_pattern do response => Orb::Models::Coupon end + + assert_pattern do + response => { + id: String, + archived_at: Time | nil, + discount: Orb::Models::Coupon::Discount, + duration_in_months: Integer | nil, + max_redemptions: Integer | nil, + redemption_code: String, + times_redeemed: Integer + } + end end def test_fetch @@ -53,5 +89,17 @@ def test_fetch assert_pattern do response => Orb::Models::Coupon end + + assert_pattern do + response => { + id: String, + archived_at: Time | nil, + discount: Orb::Models::Coupon::Discount, + duration_in_months: Integer | nil, + max_redemptions: Integer | nil, + redemption_code: String, + times_redeemed: Integer + } + end end end diff --git a/test/orb/resources/credit_notes_test.rb b/test/orb/resources/credit_notes_test.rb index fd257bfa..3ed35f30 100644 --- a/test/orb/resources/credit_notes_test.rb +++ b/test/orb/resources/credit_notes_test.rb @@ -23,6 +23,27 @@ def test_create_required_params assert_pattern do response => Orb::Models::CreditNote end + + assert_pattern do + response => { + id: String, + created_at: Time, + credit_note_number: String, + credit_note_pdf: String | nil, + customer: Orb::Models::CreditNote::Customer, + invoice_id: String, + line_items: ^(Orb::ArrayOf[Orb::Models::CreditNote::LineItem]), + maximum_amount_adjustment: Orb::Models::CreditNote::MaximumAmountAdjustment | nil, + memo: String | nil, + minimum_amount_refunded: String | nil, + reason: Orb::Models::CreditNote::Reason | nil, + subtotal: String, + total: String, + type: Orb::Models::CreditNote::Type, + voided_at: Time | nil, + discounts: ^(Orb::ArrayOf[Orb::Models::CreditNote::Discount]) | nil + } + end end def test_list @@ -41,6 +62,27 @@ def test_list assert_pattern do row => Orb::Models::CreditNote end + + assert_pattern do + row => { + id: String, + created_at: Time, + credit_note_number: String, + credit_note_pdf: String | nil, + customer: Orb::Models::CreditNote::Customer, + invoice_id: String, + line_items: ^(Orb::ArrayOf[Orb::Models::CreditNote::LineItem]), + maximum_amount_adjustment: Orb::Models::CreditNote::MaximumAmountAdjustment | nil, + memo: String | nil, + minimum_amount_refunded: String | nil, + reason: Orb::Models::CreditNote::Reason | nil, + subtotal: String, + total: String, + type: Orb::Models::CreditNote::Type, + voided_at: Time | nil, + discounts: ^(Orb::ArrayOf[Orb::Models::CreditNote::Discount]) | nil + } + end end def test_fetch @@ -49,5 +91,26 @@ def test_fetch assert_pattern do response => Orb::Models::CreditNote end + + assert_pattern do + response => { + id: String, + created_at: Time, + credit_note_number: String, + credit_note_pdf: String | nil, + customer: Orb::Models::CreditNote::Customer, + invoice_id: String, + line_items: ^(Orb::ArrayOf[Orb::Models::CreditNote::LineItem]), + maximum_amount_adjustment: Orb::Models::CreditNote::MaximumAmountAdjustment | nil, + memo: String | nil, + minimum_amount_refunded: String | nil, + reason: Orb::Models::CreditNote::Reason | nil, + subtotal: String, + total: String, + type: Orb::Models::CreditNote::Type, + voided_at: Time | nil, + discounts: ^(Orb::ArrayOf[Orb::Models::CreditNote::Discount]) | nil + } + end end end diff --git a/test/orb/resources/customers/balance_transactions_test.rb b/test/orb/resources/customers/balance_transactions_test.rb index 2b46ea22..3741c395 100644 --- a/test/orb/resources/customers/balance_transactions_test.rb +++ b/test/orb/resources/customers/balance_transactions_test.rb @@ -16,6 +16,21 @@ def test_create_required_params assert_pattern do response => Orb::Models::Customers::BalanceTransactionCreateResponse end + + assert_pattern do + response => { + id: String, + action: Orb::Models::Customers::BalanceTransactionCreateResponse::Action, + amount: String, + created_at: Time, + credit_note: Orb::Models::Customers::BalanceTransactionCreateResponse::CreditNote | nil, + description: String | nil, + ending_balance: String, + invoice: Orb::Models::Customers::BalanceTransactionCreateResponse::Invoice | nil, + starting_balance: String, + type: Orb::Models::Customers::BalanceTransactionCreateResponse::Type + } + end end def test_list @@ -34,5 +49,20 @@ def test_list assert_pattern do row => Orb::Models::Customers::BalanceTransactionListResponse end + + assert_pattern do + row => { + id: String, + action: Orb::Models::Customers::BalanceTransactionListResponse::Action, + amount: String, + created_at: Time, + credit_note: Orb::Models::Customers::BalanceTransactionListResponse::CreditNote | nil, + description: String | nil, + ending_balance: String, + invoice: Orb::Models::Customers::BalanceTransactionListResponse::Invoice | nil, + starting_balance: String, + type: Orb::Models::Customers::BalanceTransactionListResponse::Type + } + end end end diff --git a/test/orb/resources/customers/costs_test.rb b/test/orb/resources/customers/costs_test.rb index 2d42203b..29854877 100644 --- a/test/orb/resources/customers/costs_test.rb +++ b/test/orb/resources/customers/costs_test.rb @@ -16,6 +16,12 @@ def test_list assert_pattern do response => Orb::Models::Customers::CostListResponse end + + assert_pattern do + response => { + data: ^(Orb::ArrayOf[Orb::Models::Customers::CostListResponse::Data]) + } + end end def test_list_by_external_id @@ -24,5 +30,11 @@ def test_list_by_external_id assert_pattern do response => Orb::Models::Customers::CostListByExternalIDResponse end + + assert_pattern do + response => { + data: ^(Orb::ArrayOf[Orb::Models::Customers::CostListByExternalIDResponse::Data]) + } + end end end diff --git a/test/orb/resources/customers/credits/top_ups_test.rb b/test/orb/resources/customers/credits/top_ups_test.rb index fb3ebfac..449f6307 100644 --- a/test/orb/resources/customers/credits/top_ups_test.rb +++ b/test/orb/resources/customers/credits/top_ups_test.rb @@ -23,6 +23,19 @@ def test_create_required_params assert_pattern do response => Orb::Models::Customers::Credits::TopUpCreateResponse end + + assert_pattern do + response => { + id: String, + amount: String, + currency: String, + invoice_settings: Orb::Models::Customers::Credits::TopUpCreateResponse::InvoiceSettings, + per_unit_cost_basis: String, + threshold: String, + expires_after: Integer | nil, + expires_after_unit: Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit | nil + } + end end def test_list @@ -41,6 +54,19 @@ def test_list assert_pattern do row => Orb::Models::Customers::Credits::TopUpListResponse end + + assert_pattern do + row => { + id: String, + amount: String, + currency: String, + invoice_settings: Orb::Models::Customers::Credits::TopUpListResponse::InvoiceSettings, + per_unit_cost_basis: String, + threshold: String, + expires_after: Integer | nil, + expires_after_unit: Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit | nil + } + end end def test_delete_required_params @@ -64,6 +90,19 @@ def test_create_by_external_id_required_params assert_pattern do response => Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse end + + assert_pattern do + response => { + id: String, + amount: String, + currency: String, + invoice_settings: Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings, + per_unit_cost_basis: String, + threshold: String, + expires_after: Integer | nil, + expires_after_unit: Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit | nil + } + end end def test_delete_by_external_id_required_params @@ -93,5 +132,18 @@ def test_list_by_external_id assert_pattern do row => Orb::Models::Customers::Credits::TopUpListByExternalIDResponse end + + assert_pattern do + row => { + id: String, + amount: String, + currency: String, + invoice_settings: Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::InvoiceSettings, + per_unit_cost_basis: String, + threshold: String, + expires_after: Integer | nil, + expires_after_unit: Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit | nil + } + end end end diff --git a/test/orb/resources/customers/credits_test.rb b/test/orb/resources/customers/credits_test.rb index c93a0fd9..8af875eb 100644 --- a/test/orb/resources/customers/credits_test.rb +++ b/test/orb/resources/customers/credits_test.rb @@ -26,6 +26,18 @@ def test_list assert_pattern do row => Orb::Models::Customers::CreditListResponse end + + assert_pattern do + row => { + id: String, + balance: Float, + effective_date: Time | nil, + expiry_date: Time | nil, + maximum_initial_balance: Float | nil, + per_unit_cost_basis: String | nil, + status: Orb::Models::Customers::CreditListResponse::Status + } + end end def test_list_by_external_id @@ -44,5 +56,17 @@ def test_list_by_external_id assert_pattern do row => Orb::Models::Customers::CreditListByExternalIDResponse end + + assert_pattern do + row => { + id: String, + balance: Float, + effective_date: Time | nil, + expiry_date: Time | nil, + maximum_initial_balance: Float | nil, + per_unit_cost_basis: String | nil, + status: Orb::Models::Customers::CreditListByExternalIDResponse::Status + } + end end end diff --git a/test/orb/resources/customers_test.rb b/test/orb/resources/customers_test.rb index 6614fff3..ab91801a 100644 --- a/test/orb/resources/customers_test.rb +++ b/test/orb/resources/customers_test.rb @@ -16,6 +16,32 @@ def test_create_required_params assert_pattern do response => Orb::Models::Customer end + + assert_pattern do + response => { + id: String, + additional_emails: ^(Orb::ArrayOf[String]), + auto_collection: Orb::BooleanModel, + balance: String, + billing_address: Orb::Models::Customer::BillingAddress | nil, + created_at: Time, + currency: String | nil, + email: String, + email_delivery: Orb::BooleanModel, + exempt_from_automated_tax: Orb::BooleanModel | nil, + external_customer_id: String | nil, + metadata: ^(Orb::HashOf[String]), + name: String, + payment_provider: Orb::Models::Customer::PaymentProvider | nil, + payment_provider_id: String | nil, + portal_url: String | nil, + shipping_address: Orb::Models::Customer::ShippingAddress | nil, + tax_id: Orb::Models::Customer::TaxID | nil, + timezone: String, + accounting_sync_configuration: Orb::Models::Customer::AccountingSyncConfiguration | nil, + reporting_configuration: Orb::Models::Customer::ReportingConfiguration | nil + } + end end def test_update @@ -24,6 +50,32 @@ def test_update assert_pattern do response => Orb::Models::Customer end + + assert_pattern do + response => { + id: String, + additional_emails: ^(Orb::ArrayOf[String]), + auto_collection: Orb::BooleanModel, + balance: String, + billing_address: Orb::Models::Customer::BillingAddress | nil, + created_at: Time, + currency: String | nil, + email: String, + email_delivery: Orb::BooleanModel, + exempt_from_automated_tax: Orb::BooleanModel | nil, + external_customer_id: String | nil, + metadata: ^(Orb::HashOf[String]), + name: String, + payment_provider: Orb::Models::Customer::PaymentProvider | nil, + payment_provider_id: String | nil, + portal_url: String | nil, + shipping_address: Orb::Models::Customer::ShippingAddress | nil, + tax_id: Orb::Models::Customer::TaxID | nil, + timezone: String, + accounting_sync_configuration: Orb::Models::Customer::AccountingSyncConfiguration | nil, + reporting_configuration: Orb::Models::Customer::ReportingConfiguration | nil + } + end end def test_list @@ -42,6 +94,32 @@ def test_list assert_pattern do row => Orb::Models::Customer end + + assert_pattern do + row => { + id: String, + additional_emails: ^(Orb::ArrayOf[String]), + auto_collection: Orb::BooleanModel, + balance: String, + billing_address: Orb::Models::Customer::BillingAddress | nil, + created_at: Time, + currency: String | nil, + email: String, + email_delivery: Orb::BooleanModel, + exempt_from_automated_tax: Orb::BooleanModel | nil, + external_customer_id: String | nil, + metadata: ^(Orb::HashOf[String]), + name: String, + payment_provider: Orb::Models::Customer::PaymentProvider | nil, + payment_provider_id: String | nil, + portal_url: String | nil, + shipping_address: Orb::Models::Customer::ShippingAddress | nil, + tax_id: Orb::Models::Customer::TaxID | nil, + timezone: String, + accounting_sync_configuration: Orb::Models::Customer::AccountingSyncConfiguration | nil, + reporting_configuration: Orb::Models::Customer::ReportingConfiguration | nil + } + end end def test_delete @@ -58,6 +136,32 @@ def test_fetch assert_pattern do response => Orb::Models::Customer end + + assert_pattern do + response => { + id: String, + additional_emails: ^(Orb::ArrayOf[String]), + auto_collection: Orb::BooleanModel, + balance: String, + billing_address: Orb::Models::Customer::BillingAddress | nil, + created_at: Time, + currency: String | nil, + email: String, + email_delivery: Orb::BooleanModel, + exempt_from_automated_tax: Orb::BooleanModel | nil, + external_customer_id: String | nil, + metadata: ^(Orb::HashOf[String]), + name: String, + payment_provider: Orb::Models::Customer::PaymentProvider | nil, + payment_provider_id: String | nil, + portal_url: String | nil, + shipping_address: Orb::Models::Customer::ShippingAddress | nil, + tax_id: Orb::Models::Customer::TaxID | nil, + timezone: String, + accounting_sync_configuration: Orb::Models::Customer::AccountingSyncConfiguration | nil, + reporting_configuration: Orb::Models::Customer::ReportingConfiguration | nil + } + end end def test_fetch_by_external_id @@ -66,6 +170,32 @@ def test_fetch_by_external_id assert_pattern do response => Orb::Models::Customer end + + assert_pattern do + response => { + id: String, + additional_emails: ^(Orb::ArrayOf[String]), + auto_collection: Orb::BooleanModel, + balance: String, + billing_address: Orb::Models::Customer::BillingAddress | nil, + created_at: Time, + currency: String | nil, + email: String, + email_delivery: Orb::BooleanModel, + exempt_from_automated_tax: Orb::BooleanModel | nil, + external_customer_id: String | nil, + metadata: ^(Orb::HashOf[String]), + name: String, + payment_provider: Orb::Models::Customer::PaymentProvider | nil, + payment_provider_id: String | nil, + portal_url: String | nil, + shipping_address: Orb::Models::Customer::ShippingAddress | nil, + tax_id: Orb::Models::Customer::TaxID | nil, + timezone: String, + accounting_sync_configuration: Orb::Models::Customer::AccountingSyncConfiguration | nil, + reporting_configuration: Orb::Models::Customer::ReportingConfiguration | nil + } + end end def test_sync_payment_methods_from_gateway @@ -90,5 +220,31 @@ def test_update_by_external_id assert_pattern do response => Orb::Models::Customer end + + assert_pattern do + response => { + id: String, + additional_emails: ^(Orb::ArrayOf[String]), + auto_collection: Orb::BooleanModel, + balance: String, + billing_address: Orb::Models::Customer::BillingAddress | nil, + created_at: Time, + currency: String | nil, + email: String, + email_delivery: Orb::BooleanModel, + exempt_from_automated_tax: Orb::BooleanModel | nil, + external_customer_id: String | nil, + metadata: ^(Orb::HashOf[String]), + name: String, + payment_provider: Orb::Models::Customer::PaymentProvider | nil, + payment_provider_id: String | nil, + portal_url: String | nil, + shipping_address: Orb::Models::Customer::ShippingAddress | nil, + tax_id: Orb::Models::Customer::TaxID | nil, + timezone: String, + accounting_sync_configuration: Orb::Models::Customer::AccountingSyncConfiguration | nil, + reporting_configuration: Orb::Models::Customer::ReportingConfiguration | nil + } + end end end diff --git a/test/orb/resources/dimensional_price_groups/external_dimensional_price_group_id_test.rb b/test/orb/resources/dimensional_price_groups/external_dimensional_price_group_id_test.rb index fb10b70a..b5e9187a 100644 --- a/test/orb/resources/dimensional_price_groups/external_dimensional_price_group_id_test.rb +++ b/test/orb/resources/dimensional_price_groups/external_dimensional_price_group_id_test.rb @@ -18,5 +18,16 @@ def test_retrieve assert_pattern do response => Orb::Models::DimensionalPriceGroup end + + assert_pattern do + response => { + id: String, + billable_metric_id: String, + dimensions: ^(Orb::ArrayOf[String]), + external_dimensional_price_group_id: String | nil, + metadata: ^(Orb::HashOf[String]), + name: String + } + end end end diff --git a/test/orb/resources/dimensional_price_groups_test.rb b/test/orb/resources/dimensional_price_groups_test.rb index 50625503..a06004f0 100644 --- a/test/orb/resources/dimensional_price_groups_test.rb +++ b/test/orb/resources/dimensional_price_groups_test.rb @@ -20,6 +20,17 @@ def test_create_required_params assert_pattern do response => Orb::Models::DimensionalPriceGroup end + + assert_pattern do + response => { + id: String, + billable_metric_id: String, + dimensions: ^(Orb::ArrayOf[String]), + external_dimensional_price_group_id: String | nil, + metadata: ^(Orb::HashOf[String]), + name: String + } + end end def test_retrieve @@ -28,6 +39,17 @@ def test_retrieve assert_pattern do response => Orb::Models::DimensionalPriceGroup end + + assert_pattern do + response => { + id: String, + billable_metric_id: String, + dimensions: ^(Orb::ArrayOf[String]), + external_dimensional_price_group_id: String | nil, + metadata: ^(Orb::HashOf[String]), + name: String + } + end end def test_list @@ -46,5 +68,16 @@ def test_list assert_pattern do row => Orb::Models::DimensionalPriceGroup end + + assert_pattern do + row => { + id: String, + billable_metric_id: String, + dimensions: ^(Orb::ArrayOf[String]), + external_dimensional_price_group_id: String | nil, + metadata: ^(Orb::HashOf[String]), + name: String + } + end end end diff --git a/test/orb/resources/events/backfills_test.rb b/test/orb/resources/events/backfills_test.rb index c4499680..d58d0ed7 100644 --- a/test/orb/resources/events/backfills_test.rb +++ b/test/orb/resources/events/backfills_test.rb @@ -19,6 +19,22 @@ def test_create_required_params assert_pattern do response => Orb::Models::Events::BackfillCreateResponse end + + assert_pattern do + response => { + id: String, + close_time: Time | nil, + created_at: Time, + customer_id: String | nil, + events_ingested: Integer, + replace_existing_events: Orb::BooleanModel, + reverted_at: Time | nil, + status: Orb::Models::Events::BackfillCreateResponse::Status, + timeframe_end: Time, + timeframe_start: Time, + deprecation_filter: String | nil + } + end end def test_list @@ -37,6 +53,22 @@ def test_list assert_pattern do row => Orb::Models::Events::BackfillListResponse end + + assert_pattern do + row => { + id: String, + close_time: Time | nil, + created_at: Time, + customer_id: String | nil, + events_ingested: Integer, + replace_existing_events: Orb::BooleanModel, + reverted_at: Time | nil, + status: Orb::Models::Events::BackfillListResponse::Status, + timeframe_end: Time, + timeframe_start: Time, + deprecation_filter: String | nil + } + end end def test_close @@ -45,6 +77,22 @@ def test_close assert_pattern do response => Orb::Models::Events::BackfillCloseResponse end + + assert_pattern do + response => { + id: String, + close_time: Time | nil, + created_at: Time, + customer_id: String | nil, + events_ingested: Integer, + replace_existing_events: Orb::BooleanModel, + reverted_at: Time | nil, + status: Orb::Models::Events::BackfillCloseResponse::Status, + timeframe_end: Time, + timeframe_start: Time, + deprecation_filter: String | nil + } + end end def test_fetch @@ -53,6 +101,22 @@ def test_fetch assert_pattern do response => Orb::Models::Events::BackfillFetchResponse end + + assert_pattern do + response => { + id: String, + close_time: Time | nil, + created_at: Time, + customer_id: String | nil, + events_ingested: Integer, + replace_existing_events: Orb::BooleanModel, + reverted_at: Time | nil, + status: Orb::Models::Events::BackfillFetchResponse::Status, + timeframe_end: Time, + timeframe_start: Time, + deprecation_filter: String | nil + } + end end def test_revert @@ -61,5 +125,21 @@ def test_revert assert_pattern do response => Orb::Models::Events::BackfillRevertResponse end + + assert_pattern do + response => { + id: String, + close_time: Time | nil, + created_at: Time, + customer_id: String | nil, + events_ingested: Integer, + replace_existing_events: Orb::BooleanModel, + reverted_at: Time | nil, + status: Orb::Models::Events::BackfillRevertResponse::Status, + timeframe_end: Time, + timeframe_start: Time, + deprecation_filter: String | nil + } + end end end diff --git a/test/orb/resources/events/volume_test.rb b/test/orb/resources/events/volume_test.rb index 6f056a99..2bec943e 100644 --- a/test/orb/resources/events/volume_test.rb +++ b/test/orb/resources/events/volume_test.rb @@ -16,5 +16,11 @@ def test_list_required_params assert_pattern do response => Orb::Models::Events::EventVolumes end + + assert_pattern do + response => { + data: ^(Orb::ArrayOf[Orb::Models::Events::EventVolumes::Data]) + } + end end end diff --git a/test/orb/resources/events_test.rb b/test/orb/resources/events_test.rb index 1fe2418b..c9e3f79f 100644 --- a/test/orb/resources/events_test.rb +++ b/test/orb/resources/events_test.rb @@ -21,6 +21,12 @@ def test_update_required_params assert_pattern do response => Orb::Models::EventUpdateResponse end + + assert_pattern do + response => { + amended: String + } + end end def test_deprecate @@ -29,6 +35,12 @@ def test_deprecate assert_pattern do response => Orb::Models::EventDeprecateResponse end + + assert_pattern do + response => { + deprecated: String + } + end end def test_ingest_required_params @@ -46,6 +58,13 @@ def test_ingest_required_params assert_pattern do response => Orb::Models::EventIngestResponse end + + assert_pattern do + response => { + validation_failed: ^(Orb::ArrayOf[Orb::Models::EventIngestResponse::ValidationFailed]), + debug: Orb::Models::EventIngestResponse::Debug | nil + } + end end def test_search_required_params @@ -54,5 +73,11 @@ def test_search_required_params assert_pattern do response => Orb::Models::EventSearchResponse end + + assert_pattern do + response => { + data: ^(Orb::ArrayOf[Orb::Models::EventSearchResponse::Data]) + } + end end end diff --git a/test/orb/resources/invoice_line_items_test.rb b/test/orb/resources/invoice_line_items_test.rb index 1bbed6e4..0c40dafa 100644 --- a/test/orb/resources/invoice_line_items_test.rb +++ b/test/orb/resources/invoice_line_items_test.rb @@ -23,5 +23,30 @@ def test_create_required_params assert_pattern do response => Orb::Models::InvoiceLineItemCreateResponse end + + assert_pattern do + response => { + id: String, + adjusted_subtotal: String, + adjustments: ^(Orb::ArrayOf[union: Orb::Models::InvoiceLineItemCreateResponse::Adjustment]), + amount: String, + credits_applied: String, + discount: Orb::Models::Discount | nil, + end_date: Time, + grouping: String | nil, + maximum: Orb::Models::InvoiceLineItemCreateResponse::Maximum | nil, + maximum_amount: String | nil, + minimum: Orb::Models::InvoiceLineItemCreateResponse::Minimum | nil, + minimum_amount: String | nil, + name: String, + partially_invoiced_amount: String, + price: Orb::Models::Price | nil, + quantity: Float, + start_date: Time, + sub_line_items: ^(Orb::ArrayOf[union: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem]), + subtotal: String, + tax_amounts: ^(Orb::ArrayOf[Orb::Models::InvoiceLineItemCreateResponse::TaxAmount]) + } + end end end diff --git a/test/orb/resources/invoices_test.rb b/test/orb/resources/invoices_test.rb index 7a0b1c64..bfcbb405 100644 --- a/test/orb/resources/invoices_test.rb +++ b/test/orb/resources/invoices_test.rb @@ -31,6 +31,52 @@ def test_create_required_params assert_pattern do response => Orb::Models::Invoice end + + assert_pattern do + response => { + id: String, + amount_due: String, + auto_collection: Orb::Models::Invoice::AutoCollection, + billing_address: Orb::Models::Invoice::BillingAddress | nil, + created_at: Time, + credit_notes: ^(Orb::ArrayOf[Orb::Models::Invoice::CreditNote]), + currency: String, + customer: Orb::Models::Invoice::Customer, + customer_balance_transactions: ^(Orb::ArrayOf[Orb::Models::Invoice::CustomerBalanceTransaction]), + customer_tax_id: Orb::Models::Invoice::CustomerTaxID | nil, + discount: Orb::Unknown, + discounts: ^(Orb::ArrayOf[union: Orb::Models::InvoiceLevelDiscount]), + due_date: Time | nil, + eligible_to_issue_at: Time | nil, + hosted_invoice_url: String | nil, + invoice_date: Time, + invoice_number: String, + invoice_pdf: String | nil, + invoice_source: Orb::Models::Invoice::InvoiceSource, + issue_failed_at: Time | nil, + issued_at: Time | nil, + line_items: ^(Orb::ArrayOf[Orb::Models::Invoice::LineItem]), + maximum: Orb::Models::Invoice::Maximum | nil, + maximum_amount: String | nil, + memo: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::Invoice::Minimum | nil, + minimum_amount: String | nil, + paid_at: Time | nil, + payment_attempts: ^(Orb::ArrayOf[Orb::Models::Invoice::PaymentAttempt]), + payment_failed_at: Time | nil, + payment_started_at: Time | nil, + scheduled_issue_at: Time | nil, + shipping_address: Orb::Models::Invoice::ShippingAddress | nil, + status: Orb::Models::Invoice::Status, + subscription: Orb::Models::Invoice::Subscription | nil, + subtotal: String, + sync_failed_at: Time | nil, + total: String, + voided_at: Time | nil, + will_auto_issue: Orb::BooleanModel + } + end end def test_update @@ -39,6 +85,52 @@ def test_update assert_pattern do response => Orb::Models::Invoice end + + assert_pattern do + response => { + id: String, + amount_due: String, + auto_collection: Orb::Models::Invoice::AutoCollection, + billing_address: Orb::Models::Invoice::BillingAddress | nil, + created_at: Time, + credit_notes: ^(Orb::ArrayOf[Orb::Models::Invoice::CreditNote]), + currency: String, + customer: Orb::Models::Invoice::Customer, + customer_balance_transactions: ^(Orb::ArrayOf[Orb::Models::Invoice::CustomerBalanceTransaction]), + customer_tax_id: Orb::Models::Invoice::CustomerTaxID | nil, + discount: Orb::Unknown, + discounts: ^(Orb::ArrayOf[union: Orb::Models::InvoiceLevelDiscount]), + due_date: Time | nil, + eligible_to_issue_at: Time | nil, + hosted_invoice_url: String | nil, + invoice_date: Time, + invoice_number: String, + invoice_pdf: String | nil, + invoice_source: Orb::Models::Invoice::InvoiceSource, + issue_failed_at: Time | nil, + issued_at: Time | nil, + line_items: ^(Orb::ArrayOf[Orb::Models::Invoice::LineItem]), + maximum: Orb::Models::Invoice::Maximum | nil, + maximum_amount: String | nil, + memo: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::Invoice::Minimum | nil, + minimum_amount: String | nil, + paid_at: Time | nil, + payment_attempts: ^(Orb::ArrayOf[Orb::Models::Invoice::PaymentAttempt]), + payment_failed_at: Time | nil, + payment_started_at: Time | nil, + scheduled_issue_at: Time | nil, + shipping_address: Orb::Models::Invoice::ShippingAddress | nil, + status: Orb::Models::Invoice::Status, + subscription: Orb::Models::Invoice::Subscription | nil, + subtotal: String, + sync_failed_at: Time | nil, + total: String, + voided_at: Time | nil, + will_auto_issue: Orb::BooleanModel + } + end end def test_list @@ -57,6 +149,52 @@ def test_list assert_pattern do row => Orb::Models::Invoice end + + assert_pattern do + row => { + id: String, + amount_due: String, + auto_collection: Orb::Models::Invoice::AutoCollection, + billing_address: Orb::Models::Invoice::BillingAddress | nil, + created_at: Time, + credit_notes: ^(Orb::ArrayOf[Orb::Models::Invoice::CreditNote]), + currency: String, + customer: Orb::Models::Invoice::Customer, + customer_balance_transactions: ^(Orb::ArrayOf[Orb::Models::Invoice::CustomerBalanceTransaction]), + customer_tax_id: Orb::Models::Invoice::CustomerTaxID | nil, + discount: Orb::Unknown, + discounts: ^(Orb::ArrayOf[union: Orb::Models::InvoiceLevelDiscount]), + due_date: Time | nil, + eligible_to_issue_at: Time | nil, + hosted_invoice_url: String | nil, + invoice_date: Time, + invoice_number: String, + invoice_pdf: String | nil, + invoice_source: Orb::Models::Invoice::InvoiceSource, + issue_failed_at: Time | nil, + issued_at: Time | nil, + line_items: ^(Orb::ArrayOf[Orb::Models::Invoice::LineItem]), + maximum: Orb::Models::Invoice::Maximum | nil, + maximum_amount: String | nil, + memo: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::Invoice::Minimum | nil, + minimum_amount: String | nil, + paid_at: Time | nil, + payment_attempts: ^(Orb::ArrayOf[Orb::Models::Invoice::PaymentAttempt]), + payment_failed_at: Time | nil, + payment_started_at: Time | nil, + scheduled_issue_at: Time | nil, + shipping_address: Orb::Models::Invoice::ShippingAddress | nil, + status: Orb::Models::Invoice::Status, + subscription: Orb::Models::Invoice::Subscription | nil, + subtotal: String, + sync_failed_at: Time | nil, + total: String, + voided_at: Time | nil, + will_auto_issue: Orb::BooleanModel + } + end end def test_fetch @@ -65,6 +203,52 @@ def test_fetch assert_pattern do response => Orb::Models::Invoice end + + assert_pattern do + response => { + id: String, + amount_due: String, + auto_collection: Orb::Models::Invoice::AutoCollection, + billing_address: Orb::Models::Invoice::BillingAddress | nil, + created_at: Time, + credit_notes: ^(Orb::ArrayOf[Orb::Models::Invoice::CreditNote]), + currency: String, + customer: Orb::Models::Invoice::Customer, + customer_balance_transactions: ^(Orb::ArrayOf[Orb::Models::Invoice::CustomerBalanceTransaction]), + customer_tax_id: Orb::Models::Invoice::CustomerTaxID | nil, + discount: Orb::Unknown, + discounts: ^(Orb::ArrayOf[union: Orb::Models::InvoiceLevelDiscount]), + due_date: Time | nil, + eligible_to_issue_at: Time | nil, + hosted_invoice_url: String | nil, + invoice_date: Time, + invoice_number: String, + invoice_pdf: String | nil, + invoice_source: Orb::Models::Invoice::InvoiceSource, + issue_failed_at: Time | nil, + issued_at: Time | nil, + line_items: ^(Orb::ArrayOf[Orb::Models::Invoice::LineItem]), + maximum: Orb::Models::Invoice::Maximum | nil, + maximum_amount: String | nil, + memo: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::Invoice::Minimum | nil, + minimum_amount: String | nil, + paid_at: Time | nil, + payment_attempts: ^(Orb::ArrayOf[Orb::Models::Invoice::PaymentAttempt]), + payment_failed_at: Time | nil, + payment_started_at: Time | nil, + scheduled_issue_at: Time | nil, + shipping_address: Orb::Models::Invoice::ShippingAddress | nil, + status: Orb::Models::Invoice::Status, + subscription: Orb::Models::Invoice::Subscription | nil, + subtotal: String, + sync_failed_at: Time | nil, + total: String, + voided_at: Time | nil, + will_auto_issue: Orb::BooleanModel + } + end end def test_fetch_upcoming_required_params @@ -73,6 +257,52 @@ def test_fetch_upcoming_required_params assert_pattern do response => Orb::Models::InvoiceFetchUpcomingResponse end + + assert_pattern do + response => { + id: String, + amount_due: String, + auto_collection: Orb::Models::InvoiceFetchUpcomingResponse::AutoCollection, + billing_address: Orb::Models::InvoiceFetchUpcomingResponse::BillingAddress | nil, + created_at: Time, + credit_notes: ^(Orb::ArrayOf[Orb::Models::InvoiceFetchUpcomingResponse::CreditNote]), + currency: String, + customer: Orb::Models::InvoiceFetchUpcomingResponse::Customer, + customer_balance_transactions: ^(Orb::ArrayOf[Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction]), + customer_tax_id: Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID | nil, + discount: Orb::Unknown, + discounts: ^(Orb::ArrayOf[union: Orb::Models::InvoiceLevelDiscount]), + due_date: Time | nil, + eligible_to_issue_at: Time | nil, + hosted_invoice_url: String | nil, + invoice_number: String, + invoice_pdf: String | nil, + invoice_source: Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource, + issue_failed_at: Time | nil, + issued_at: Time | nil, + line_items: ^(Orb::ArrayOf[Orb::Models::InvoiceFetchUpcomingResponse::LineItem]), + maximum: Orb::Models::InvoiceFetchUpcomingResponse::Maximum | nil, + maximum_amount: String | nil, + memo: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::InvoiceFetchUpcomingResponse::Minimum | nil, + minimum_amount: String | nil, + paid_at: Time | nil, + payment_attempts: ^(Orb::ArrayOf[Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt]), + payment_failed_at: Time | nil, + payment_started_at: Time | nil, + scheduled_issue_at: Time | nil, + shipping_address: Orb::Models::InvoiceFetchUpcomingResponse::ShippingAddress | nil, + status: Orb::Models::InvoiceFetchUpcomingResponse::Status, + subscription: Orb::Models::InvoiceFetchUpcomingResponse::Subscription | nil, + subtotal: String, + sync_failed_at: Time | nil, + target_date: Time, + total: String, + voided_at: Time | nil, + will_auto_issue: Orb::BooleanModel + } + end end def test_issue @@ -81,6 +311,52 @@ def test_issue assert_pattern do response => Orb::Models::Invoice end + + assert_pattern do + response => { + id: String, + amount_due: String, + auto_collection: Orb::Models::Invoice::AutoCollection, + billing_address: Orb::Models::Invoice::BillingAddress | nil, + created_at: Time, + credit_notes: ^(Orb::ArrayOf[Orb::Models::Invoice::CreditNote]), + currency: String, + customer: Orb::Models::Invoice::Customer, + customer_balance_transactions: ^(Orb::ArrayOf[Orb::Models::Invoice::CustomerBalanceTransaction]), + customer_tax_id: Orb::Models::Invoice::CustomerTaxID | nil, + discount: Orb::Unknown, + discounts: ^(Orb::ArrayOf[union: Orb::Models::InvoiceLevelDiscount]), + due_date: Time | nil, + eligible_to_issue_at: Time | nil, + hosted_invoice_url: String | nil, + invoice_date: Time, + invoice_number: String, + invoice_pdf: String | nil, + invoice_source: Orb::Models::Invoice::InvoiceSource, + issue_failed_at: Time | nil, + issued_at: Time | nil, + line_items: ^(Orb::ArrayOf[Orb::Models::Invoice::LineItem]), + maximum: Orb::Models::Invoice::Maximum | nil, + maximum_amount: String | nil, + memo: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::Invoice::Minimum | nil, + minimum_amount: String | nil, + paid_at: Time | nil, + payment_attempts: ^(Orb::ArrayOf[Orb::Models::Invoice::PaymentAttempt]), + payment_failed_at: Time | nil, + payment_started_at: Time | nil, + scheduled_issue_at: Time | nil, + shipping_address: Orb::Models::Invoice::ShippingAddress | nil, + status: Orb::Models::Invoice::Status, + subscription: Orb::Models::Invoice::Subscription | nil, + subtotal: String, + sync_failed_at: Time | nil, + total: String, + voided_at: Time | nil, + will_auto_issue: Orb::BooleanModel + } + end end def test_mark_paid_required_params @@ -89,6 +365,52 @@ def test_mark_paid_required_params assert_pattern do response => Orb::Models::Invoice end + + assert_pattern do + response => { + id: String, + amount_due: String, + auto_collection: Orb::Models::Invoice::AutoCollection, + billing_address: Orb::Models::Invoice::BillingAddress | nil, + created_at: Time, + credit_notes: ^(Orb::ArrayOf[Orb::Models::Invoice::CreditNote]), + currency: String, + customer: Orb::Models::Invoice::Customer, + customer_balance_transactions: ^(Orb::ArrayOf[Orb::Models::Invoice::CustomerBalanceTransaction]), + customer_tax_id: Orb::Models::Invoice::CustomerTaxID | nil, + discount: Orb::Unknown, + discounts: ^(Orb::ArrayOf[union: Orb::Models::InvoiceLevelDiscount]), + due_date: Time | nil, + eligible_to_issue_at: Time | nil, + hosted_invoice_url: String | nil, + invoice_date: Time, + invoice_number: String, + invoice_pdf: String | nil, + invoice_source: Orb::Models::Invoice::InvoiceSource, + issue_failed_at: Time | nil, + issued_at: Time | nil, + line_items: ^(Orb::ArrayOf[Orb::Models::Invoice::LineItem]), + maximum: Orb::Models::Invoice::Maximum | nil, + maximum_amount: String | nil, + memo: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::Invoice::Minimum | nil, + minimum_amount: String | nil, + paid_at: Time | nil, + payment_attempts: ^(Orb::ArrayOf[Orb::Models::Invoice::PaymentAttempt]), + payment_failed_at: Time | nil, + payment_started_at: Time | nil, + scheduled_issue_at: Time | nil, + shipping_address: Orb::Models::Invoice::ShippingAddress | nil, + status: Orb::Models::Invoice::Status, + subscription: Orb::Models::Invoice::Subscription | nil, + subtotal: String, + sync_failed_at: Time | nil, + total: String, + voided_at: Time | nil, + will_auto_issue: Orb::BooleanModel + } + end end def test_pay @@ -97,6 +419,52 @@ def test_pay assert_pattern do response => Orb::Models::Invoice end + + assert_pattern do + response => { + id: String, + amount_due: String, + auto_collection: Orb::Models::Invoice::AutoCollection, + billing_address: Orb::Models::Invoice::BillingAddress | nil, + created_at: Time, + credit_notes: ^(Orb::ArrayOf[Orb::Models::Invoice::CreditNote]), + currency: String, + customer: Orb::Models::Invoice::Customer, + customer_balance_transactions: ^(Orb::ArrayOf[Orb::Models::Invoice::CustomerBalanceTransaction]), + customer_tax_id: Orb::Models::Invoice::CustomerTaxID | nil, + discount: Orb::Unknown, + discounts: ^(Orb::ArrayOf[union: Orb::Models::InvoiceLevelDiscount]), + due_date: Time | nil, + eligible_to_issue_at: Time | nil, + hosted_invoice_url: String | nil, + invoice_date: Time, + invoice_number: String, + invoice_pdf: String | nil, + invoice_source: Orb::Models::Invoice::InvoiceSource, + issue_failed_at: Time | nil, + issued_at: Time | nil, + line_items: ^(Orb::ArrayOf[Orb::Models::Invoice::LineItem]), + maximum: Orb::Models::Invoice::Maximum | nil, + maximum_amount: String | nil, + memo: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::Invoice::Minimum | nil, + minimum_amount: String | nil, + paid_at: Time | nil, + payment_attempts: ^(Orb::ArrayOf[Orb::Models::Invoice::PaymentAttempt]), + payment_failed_at: Time | nil, + payment_started_at: Time | nil, + scheduled_issue_at: Time | nil, + shipping_address: Orb::Models::Invoice::ShippingAddress | nil, + status: Orb::Models::Invoice::Status, + subscription: Orb::Models::Invoice::Subscription | nil, + subtotal: String, + sync_failed_at: Time | nil, + total: String, + voided_at: Time | nil, + will_auto_issue: Orb::BooleanModel + } + end end def test_void @@ -105,5 +473,51 @@ def test_void assert_pattern do response => Orb::Models::Invoice end + + assert_pattern do + response => { + id: String, + amount_due: String, + auto_collection: Orb::Models::Invoice::AutoCollection, + billing_address: Orb::Models::Invoice::BillingAddress | nil, + created_at: Time, + credit_notes: ^(Orb::ArrayOf[Orb::Models::Invoice::CreditNote]), + currency: String, + customer: Orb::Models::Invoice::Customer, + customer_balance_transactions: ^(Orb::ArrayOf[Orb::Models::Invoice::CustomerBalanceTransaction]), + customer_tax_id: Orb::Models::Invoice::CustomerTaxID | nil, + discount: Orb::Unknown, + discounts: ^(Orb::ArrayOf[union: Orb::Models::InvoiceLevelDiscount]), + due_date: Time | nil, + eligible_to_issue_at: Time | nil, + hosted_invoice_url: String | nil, + invoice_date: Time, + invoice_number: String, + invoice_pdf: String | nil, + invoice_source: Orb::Models::Invoice::InvoiceSource, + issue_failed_at: Time | nil, + issued_at: Time | nil, + line_items: ^(Orb::ArrayOf[Orb::Models::Invoice::LineItem]), + maximum: Orb::Models::Invoice::Maximum | nil, + maximum_amount: String | nil, + memo: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::Invoice::Minimum | nil, + minimum_amount: String | nil, + paid_at: Time | nil, + payment_attempts: ^(Orb::ArrayOf[Orb::Models::Invoice::PaymentAttempt]), + payment_failed_at: Time | nil, + payment_started_at: Time | nil, + scheduled_issue_at: Time | nil, + shipping_address: Orb::Models::Invoice::ShippingAddress | nil, + status: Orb::Models::Invoice::Status, + subscription: Orb::Models::Invoice::Subscription | nil, + subtotal: String, + sync_failed_at: Time | nil, + total: String, + voided_at: Time | nil, + will_auto_issue: Orb::BooleanModel + } + end end end diff --git a/test/orb/resources/items_test.rb b/test/orb/resources/items_test.rb index dd25aa25..a887437b 100644 --- a/test/orb/resources/items_test.rb +++ b/test/orb/resources/items_test.rb @@ -16,6 +16,15 @@ def test_create_required_params assert_pattern do response => Orb::Models::Item end + + assert_pattern do + response => { + id: String, + created_at: Time, + external_connections: ^(Orb::ArrayOf[Orb::Models::Item::ExternalConnection]), + name: String + } + end end def test_update @@ -24,6 +33,15 @@ def test_update assert_pattern do response => Orb::Models::Item end + + assert_pattern do + response => { + id: String, + created_at: Time, + external_connections: ^(Orb::ArrayOf[Orb::Models::Item::ExternalConnection]), + name: String + } + end end def test_list @@ -42,6 +60,15 @@ def test_list assert_pattern do row => Orb::Models::Item end + + assert_pattern do + row => { + id: String, + created_at: Time, + external_connections: ^(Orb::ArrayOf[Orb::Models::Item::ExternalConnection]), + name: String + } + end end def test_fetch @@ -50,5 +77,14 @@ def test_fetch assert_pattern do response => Orb::Models::Item end + + assert_pattern do + response => { + id: String, + created_at: Time, + external_connections: ^(Orb::ArrayOf[Orb::Models::Item::ExternalConnection]), + name: String + } + end end end diff --git a/test/orb/resources/metrics_test.rb b/test/orb/resources/metrics_test.rb index 2c30faa9..e8b50edf 100644 --- a/test/orb/resources/metrics_test.rb +++ b/test/orb/resources/metrics_test.rb @@ -21,6 +21,17 @@ def test_create_required_params assert_pattern do response => Orb::Models::BillableMetric end + + assert_pattern do + response => { + id: String, + description: String | nil, + item: Orb::Models::Item, + metadata: ^(Orb::HashOf[String]), + name: String, + status: Orb::Models::BillableMetric::Status + } + end end def test_update @@ -29,6 +40,17 @@ def test_update assert_pattern do response => Orb::Models::BillableMetric end + + assert_pattern do + response => { + id: String, + description: String | nil, + item: Orb::Models::Item, + metadata: ^(Orb::HashOf[String]), + name: String, + status: Orb::Models::BillableMetric::Status + } + end end def test_list @@ -47,6 +69,17 @@ def test_list assert_pattern do row => Orb::Models::BillableMetric end + + assert_pattern do + row => { + id: String, + description: String | nil, + item: Orb::Models::Item, + metadata: ^(Orb::HashOf[String]), + name: String, + status: Orb::Models::BillableMetric::Status + } + end end def test_fetch @@ -55,5 +88,16 @@ def test_fetch assert_pattern do response => Orb::Models::BillableMetric end + + assert_pattern do + response => { + id: String, + description: String | nil, + item: Orb::Models::Item, + metadata: ^(Orb::HashOf[String]), + name: String, + status: Orb::Models::BillableMetric::Status + } + end end end diff --git a/test/orb/resources/plans/external_plan_id_test.rb b/test/orb/resources/plans/external_plan_id_test.rb index 51cf9dc9..36b33748 100644 --- a/test/orb/resources/plans/external_plan_id_test.rb +++ b/test/orb/resources/plans/external_plan_id_test.rb @@ -16,6 +16,35 @@ def test_update assert_pattern do response => Orb::Models::Plan end + + assert_pattern do + response => { + id: String, + adjustments: ^(Orb::ArrayOf[union: Orb::Models::Plan::Adjustment]), + base_plan: Orb::Models::Plan::BasePlan | nil, + base_plan_id: String | nil, + created_at: Time, + currency: String, + default_invoice_memo: String | nil, + description: String, + discount: Orb::Models::Discount | nil, + external_plan_id: String | nil, + invoicing_currency: String, + maximum: Orb::Models::Plan::Maximum | nil, + maximum_amount: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::Plan::Minimum | nil, + minimum_amount: String | nil, + name: String, + net_terms: Integer | nil, + plan_phases: ^(Orb::ArrayOf[Orb::Models::Plan::PlanPhase]) | nil, + prices: ^(Orb::ArrayOf[union: Orb::Models::Price]), + product: Orb::Models::Plan::Product, + status: Orb::Models::Plan::Status, + trial_config: Orb::Models::Plan::TrialConfig, + version: Integer + } + end end def test_fetch @@ -24,5 +53,34 @@ def test_fetch assert_pattern do response => Orb::Models::Plan end + + assert_pattern do + response => { + id: String, + adjustments: ^(Orb::ArrayOf[union: Orb::Models::Plan::Adjustment]), + base_plan: Orb::Models::Plan::BasePlan | nil, + base_plan_id: String | nil, + created_at: Time, + currency: String, + default_invoice_memo: String | nil, + description: String, + discount: Orb::Models::Discount | nil, + external_plan_id: String | nil, + invoicing_currency: String, + maximum: Orb::Models::Plan::Maximum | nil, + maximum_amount: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::Plan::Minimum | nil, + minimum_amount: String | nil, + name: String, + net_terms: Integer | nil, + plan_phases: ^(Orb::ArrayOf[Orb::Models::Plan::PlanPhase]) | nil, + prices: ^(Orb::ArrayOf[union: Orb::Models::Price]), + product: Orb::Models::Plan::Product, + status: Orb::Models::Plan::Status, + trial_config: Orb::Models::Plan::TrialConfig, + version: Integer + } + end end end diff --git a/test/orb/resources/plans_test.rb b/test/orb/resources/plans_test.rb index cdfb032e..f698a02b 100644 --- a/test/orb/resources/plans_test.rb +++ b/test/orb/resources/plans_test.rb @@ -28,6 +28,35 @@ def test_create_required_params assert_pattern do response => Orb::Models::Plan end + + assert_pattern do + response => { + id: String, + adjustments: ^(Orb::ArrayOf[union: Orb::Models::Plan::Adjustment]), + base_plan: Orb::Models::Plan::BasePlan | nil, + base_plan_id: String | nil, + created_at: Time, + currency: String, + default_invoice_memo: String | nil, + description: String, + discount: Orb::Models::Discount | nil, + external_plan_id: String | nil, + invoicing_currency: String, + maximum: Orb::Models::Plan::Maximum | nil, + maximum_amount: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::Plan::Minimum | nil, + minimum_amount: String | nil, + name: String, + net_terms: Integer | nil, + plan_phases: ^(Orb::ArrayOf[Orb::Models::Plan::PlanPhase]) | nil, + prices: ^(Orb::ArrayOf[union: Orb::Models::Price]), + product: Orb::Models::Plan::Product, + status: Orb::Models::Plan::Status, + trial_config: Orb::Models::Plan::TrialConfig, + version: Integer + } + end end def test_update @@ -36,6 +65,35 @@ def test_update assert_pattern do response => Orb::Models::Plan end + + assert_pattern do + response => { + id: String, + adjustments: ^(Orb::ArrayOf[union: Orb::Models::Plan::Adjustment]), + base_plan: Orb::Models::Plan::BasePlan | nil, + base_plan_id: String | nil, + created_at: Time, + currency: String, + default_invoice_memo: String | nil, + description: String, + discount: Orb::Models::Discount | nil, + external_plan_id: String | nil, + invoicing_currency: String, + maximum: Orb::Models::Plan::Maximum | nil, + maximum_amount: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::Plan::Minimum | nil, + minimum_amount: String | nil, + name: String, + net_terms: Integer | nil, + plan_phases: ^(Orb::ArrayOf[Orb::Models::Plan::PlanPhase]) | nil, + prices: ^(Orb::ArrayOf[union: Orb::Models::Price]), + product: Orb::Models::Plan::Product, + status: Orb::Models::Plan::Status, + trial_config: Orb::Models::Plan::TrialConfig, + version: Integer + } + end end def test_list @@ -54,6 +112,35 @@ def test_list assert_pattern do row => Orb::Models::Plan end + + assert_pattern do + row => { + id: String, + adjustments: ^(Orb::ArrayOf[union: Orb::Models::Plan::Adjustment]), + base_plan: Orb::Models::Plan::BasePlan | nil, + base_plan_id: String | nil, + created_at: Time, + currency: String, + default_invoice_memo: String | nil, + description: String, + discount: Orb::Models::Discount | nil, + external_plan_id: String | nil, + invoicing_currency: String, + maximum: Orb::Models::Plan::Maximum | nil, + maximum_amount: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::Plan::Minimum | nil, + minimum_amount: String | nil, + name: String, + net_terms: Integer | nil, + plan_phases: ^(Orb::ArrayOf[Orb::Models::Plan::PlanPhase]) | nil, + prices: ^(Orb::ArrayOf[union: Orb::Models::Price]), + product: Orb::Models::Plan::Product, + status: Orb::Models::Plan::Status, + trial_config: Orb::Models::Plan::TrialConfig, + version: Integer + } + end end def test_fetch @@ -62,5 +149,34 @@ def test_fetch assert_pattern do response => Orb::Models::Plan end + + assert_pattern do + response => { + id: String, + adjustments: ^(Orb::ArrayOf[union: Orb::Models::Plan::Adjustment]), + base_plan: Orb::Models::Plan::BasePlan | nil, + base_plan_id: String | nil, + created_at: Time, + currency: String, + default_invoice_memo: String | nil, + description: String, + discount: Orb::Models::Discount | nil, + external_plan_id: String | nil, + invoicing_currency: String, + maximum: Orb::Models::Plan::Maximum | nil, + maximum_amount: String | nil, + metadata: ^(Orb::HashOf[String]), + minimum: Orb::Models::Plan::Minimum | nil, + minimum_amount: String | nil, + name: String, + net_terms: Integer | nil, + plan_phases: ^(Orb::ArrayOf[Orb::Models::Plan::PlanPhase]) | nil, + prices: ^(Orb::ArrayOf[union: Orb::Models::Price]), + product: Orb::Models::Plan::Product, + status: Orb::Models::Plan::Status, + trial_config: Orb::Models::Plan::TrialConfig, + version: Integer + } + end end end diff --git a/test/orb/resources/prices_test.rb b/test/orb/resources/prices_test.rb index f5d1fbfc..ba9c2d32 100644 --- a/test/orb/resources/prices_test.rb +++ b/test/orb/resources/prices_test.rb @@ -61,6 +61,12 @@ def test_evaluate_required_params assert_pattern do response => Orb::Models::PriceEvaluateResponse end + + assert_pattern do + response => { + data: ^(Orb::ArrayOf[Orb::Models::EvaluatePriceGroup]) + } + end end def test_fetch diff --git a/test/orb/resources/subscriptions_test.rb b/test/orb/resources/subscriptions_test.rb index ca8a0be6..0d7bf490 100644 --- a/test/orb/resources/subscriptions_test.rb +++ b/test/orb/resources/subscriptions_test.rb @@ -16,6 +16,36 @@ def test_create assert_pattern do response => Orb::Models::SubscriptionCreateResponse end + + assert_pattern do + response => { + id: String, + active_plan_phase_order: Integer | nil, + adjustment_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionCreateResponse::AdjustmentInterval]), + auto_collection: Orb::BooleanModel | nil, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionCreateResponse::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time | nil, + current_billing_period_start_date: Time | nil, + customer: Orb::Models::Customer, + default_invoice_memo: String | nil, + discount_intervals: ^(Orb::ArrayOf[union: Orb::Models::SubscriptionCreateResponse::DiscountInterval]), + end_date: Time | nil, + fixed_fee_quantity_schedule: ^(Orb::ArrayOf[Orb::Models::SubscriptionCreateResponse::FixedFeeQuantitySchedule]), + invoicing_threshold: String | nil, + maximum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionCreateResponse::MaximumInterval]), + metadata: ^(Orb::HashOf[String]), + minimum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionCreateResponse::MinimumInterval]), + net_terms: Integer, + plan: Orb::Models::Plan, + price_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionCreateResponse::PriceInterval]), + redeemed_coupon: Orb::Models::SubscriptionCreateResponse::RedeemedCoupon | nil, + start_date: Time, + status: Orb::Models::SubscriptionCreateResponse::Status, + trial_info: Orb::Models::SubscriptionCreateResponse::TrialInfo + } + end end def test_update @@ -24,6 +54,36 @@ def test_update assert_pattern do response => Orb::Models::Subscription end + + assert_pattern do + response => { + id: String, + active_plan_phase_order: Integer | nil, + adjustment_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::AdjustmentInterval]), + auto_collection: Orb::BooleanModel | nil, + billing_cycle_anchor_configuration: Orb::Models::Subscription::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time | nil, + current_billing_period_start_date: Time | nil, + customer: Orb::Models::Customer, + default_invoice_memo: String | nil, + discount_intervals: ^(Orb::ArrayOf[union: Orb::Models::Subscription::DiscountInterval]), + end_date: Time | nil, + fixed_fee_quantity_schedule: ^(Orb::ArrayOf[Orb::Models::Subscription::FixedFeeQuantitySchedule]), + invoicing_threshold: String | nil, + maximum_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::MaximumInterval]), + metadata: ^(Orb::HashOf[String]), + minimum_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::MinimumInterval]), + net_terms: Integer, + plan: Orb::Models::Plan, + price_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::PriceInterval]), + redeemed_coupon: Orb::Models::Subscription::RedeemedCoupon | nil, + start_date: Time, + status: Orb::Models::Subscription::Status, + trial_info: Orb::Models::Subscription::TrialInfo + } + end end def test_list @@ -42,6 +102,36 @@ def test_list assert_pattern do row => Orb::Models::Subscription end + + assert_pattern do + row => { + id: String, + active_plan_phase_order: Integer | nil, + adjustment_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::AdjustmentInterval]), + auto_collection: Orb::BooleanModel | nil, + billing_cycle_anchor_configuration: Orb::Models::Subscription::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time | nil, + current_billing_period_start_date: Time | nil, + customer: Orb::Models::Customer, + default_invoice_memo: String | nil, + discount_intervals: ^(Orb::ArrayOf[union: Orb::Models::Subscription::DiscountInterval]), + end_date: Time | nil, + fixed_fee_quantity_schedule: ^(Orb::ArrayOf[Orb::Models::Subscription::FixedFeeQuantitySchedule]), + invoicing_threshold: String | nil, + maximum_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::MaximumInterval]), + metadata: ^(Orb::HashOf[String]), + minimum_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::MinimumInterval]), + net_terms: Integer, + plan: Orb::Models::Plan, + price_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::PriceInterval]), + redeemed_coupon: Orb::Models::Subscription::RedeemedCoupon | nil, + start_date: Time, + status: Orb::Models::Subscription::Status, + trial_info: Orb::Models::Subscription::TrialInfo + } + end end def test_cancel_required_params @@ -50,6 +140,36 @@ def test_cancel_required_params assert_pattern do response => Orb::Models::SubscriptionCancelResponse end + + assert_pattern do + response => { + id: String, + active_plan_phase_order: Integer | nil, + adjustment_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionCancelResponse::AdjustmentInterval]), + auto_collection: Orb::BooleanModel | nil, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionCancelResponse::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time | nil, + current_billing_period_start_date: Time | nil, + customer: Orb::Models::Customer, + default_invoice_memo: String | nil, + discount_intervals: ^(Orb::ArrayOf[union: Orb::Models::SubscriptionCancelResponse::DiscountInterval]), + end_date: Time | nil, + fixed_fee_quantity_schedule: ^(Orb::ArrayOf[Orb::Models::SubscriptionCancelResponse::FixedFeeQuantitySchedule]), + invoicing_threshold: String | nil, + maximum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionCancelResponse::MaximumInterval]), + metadata: ^(Orb::HashOf[String]), + minimum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionCancelResponse::MinimumInterval]), + net_terms: Integer, + plan: Orb::Models::Plan, + price_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionCancelResponse::PriceInterval]), + redeemed_coupon: Orb::Models::SubscriptionCancelResponse::RedeemedCoupon | nil, + start_date: Time, + status: Orb::Models::SubscriptionCancelResponse::Status, + trial_info: Orb::Models::SubscriptionCancelResponse::TrialInfo + } + end end def test_fetch @@ -58,6 +178,36 @@ def test_fetch assert_pattern do response => Orb::Models::Subscription end + + assert_pattern do + response => { + id: String, + active_plan_phase_order: Integer | nil, + adjustment_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::AdjustmentInterval]), + auto_collection: Orb::BooleanModel | nil, + billing_cycle_anchor_configuration: Orb::Models::Subscription::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time | nil, + current_billing_period_start_date: Time | nil, + customer: Orb::Models::Customer, + default_invoice_memo: String | nil, + discount_intervals: ^(Orb::ArrayOf[union: Orb::Models::Subscription::DiscountInterval]), + end_date: Time | nil, + fixed_fee_quantity_schedule: ^(Orb::ArrayOf[Orb::Models::Subscription::FixedFeeQuantitySchedule]), + invoicing_threshold: String | nil, + maximum_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::MaximumInterval]), + metadata: ^(Orb::HashOf[String]), + minimum_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::MinimumInterval]), + net_terms: Integer, + plan: Orb::Models::Plan, + price_intervals: ^(Orb::ArrayOf[Orb::Models::Subscription::PriceInterval]), + redeemed_coupon: Orb::Models::Subscription::RedeemedCoupon | nil, + start_date: Time, + status: Orb::Models::Subscription::Status, + trial_info: Orb::Models::Subscription::TrialInfo + } + end end def test_fetch_costs @@ -66,6 +216,12 @@ def test_fetch_costs assert_pattern do response => Orb::Models::SubscriptionFetchCostsResponse end + + assert_pattern do + response => { + data: ^(Orb::ArrayOf[Orb::Models::SubscriptionFetchCostsResponse::Data]) + } + end end def test_fetch_schedule @@ -84,6 +240,15 @@ def test_fetch_schedule assert_pattern do row => Orb::Models::SubscriptionFetchScheduleResponse end + + assert_pattern do + row => { + created_at: Time, + end_date: Time | nil, + plan: Orb::Models::SubscriptionFetchScheduleResponse::Plan, + start_date: Time + } + end end def test_fetch_usage @@ -104,6 +269,36 @@ def test_price_intervals assert_pattern do response => Orb::Models::SubscriptionPriceIntervalsResponse end + + assert_pattern do + response => { + id: String, + active_plan_phase_order: Integer | nil, + adjustment_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval]), + auto_collection: Orb::BooleanModel | nil, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionPriceIntervalsResponse::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time | nil, + current_billing_period_start_date: Time | nil, + customer: Orb::Models::Customer, + default_invoice_memo: String | nil, + discount_intervals: ^(Orb::ArrayOf[union: Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval]), + end_date: Time | nil, + fixed_fee_quantity_schedule: ^(Orb::ArrayOf[Orb::Models::SubscriptionPriceIntervalsResponse::FixedFeeQuantitySchedule]), + invoicing_threshold: String | nil, + maximum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionPriceIntervalsResponse::MaximumInterval]), + metadata: ^(Orb::HashOf[String]), + minimum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionPriceIntervalsResponse::MinimumInterval]), + net_terms: Integer, + plan: Orb::Models::Plan, + price_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval]), + redeemed_coupon: Orb::Models::SubscriptionPriceIntervalsResponse::RedeemedCoupon | nil, + start_date: Time, + status: Orb::Models::SubscriptionPriceIntervalsResponse::Status, + trial_info: Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo + } + end end def test_schedule_plan_change_required_params @@ -112,6 +307,36 @@ def test_schedule_plan_change_required_params assert_pattern do response => Orb::Models::SubscriptionSchedulePlanChangeResponse end + + assert_pattern do + response => { + id: String, + active_plan_phase_order: Integer | nil, + adjustment_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval]), + auto_collection: Orb::BooleanModel | nil, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time | nil, + current_billing_period_start_date: Time | nil, + customer: Orb::Models::Customer, + default_invoice_memo: String | nil, + discount_intervals: ^(Orb::ArrayOf[union: Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval]), + end_date: Time | nil, + fixed_fee_quantity_schedule: ^(Orb::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule]), + invoicing_threshold: String | nil, + maximum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval]), + metadata: ^(Orb::HashOf[String]), + minimum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval]), + net_terms: Integer, + plan: Orb::Models::Plan, + price_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval]), + redeemed_coupon: Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon | nil, + start_date: Time, + status: Orb::Models::SubscriptionSchedulePlanChangeResponse::Status, + trial_info: Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo + } + end end def test_trigger_phase @@ -120,6 +345,36 @@ def test_trigger_phase assert_pattern do response => Orb::Models::SubscriptionTriggerPhaseResponse end + + assert_pattern do + response => { + id: String, + active_plan_phase_order: Integer | nil, + adjustment_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval]), + auto_collection: Orb::BooleanModel | nil, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionTriggerPhaseResponse::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time | nil, + current_billing_period_start_date: Time | nil, + customer: Orb::Models::Customer, + default_invoice_memo: String | nil, + discount_intervals: ^(Orb::ArrayOf[union: Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval]), + end_date: Time | nil, + fixed_fee_quantity_schedule: ^(Orb::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::FixedFeeQuantitySchedule]), + invoicing_threshold: String | nil, + maximum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval]), + metadata: ^(Orb::HashOf[String]), + minimum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval]), + net_terms: Integer, + plan: Orb::Models::Plan, + price_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval]), + redeemed_coupon: Orb::Models::SubscriptionTriggerPhaseResponse::RedeemedCoupon | nil, + start_date: Time, + status: Orb::Models::SubscriptionTriggerPhaseResponse::Status, + trial_info: Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo + } + end end def test_unschedule_cancellation @@ -128,6 +383,36 @@ def test_unschedule_cancellation assert_pattern do response => Orb::Models::SubscriptionUnscheduleCancellationResponse end + + assert_pattern do + response => { + id: String, + active_plan_phase_order: Integer | nil, + adjustment_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval]), + auto_collection: Orb::BooleanModel | nil, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionUnscheduleCancellationResponse::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time | nil, + current_billing_period_start_date: Time | nil, + customer: Orb::Models::Customer, + default_invoice_memo: String | nil, + discount_intervals: ^(Orb::ArrayOf[union: Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval]), + end_date: Time | nil, + fixed_fee_quantity_schedule: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnscheduleCancellationResponse::FixedFeeQuantitySchedule]), + invoicing_threshold: String | nil, + maximum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnscheduleCancellationResponse::MaximumInterval]), + metadata: ^(Orb::HashOf[String]), + minimum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnscheduleCancellationResponse::MinimumInterval]), + net_terms: Integer, + plan: Orb::Models::Plan, + price_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnscheduleCancellationResponse::PriceInterval]), + redeemed_coupon: Orb::Models::SubscriptionUnscheduleCancellationResponse::RedeemedCoupon | nil, + start_date: Time, + status: Orb::Models::SubscriptionUnscheduleCancellationResponse::Status, + trial_info: Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo + } + end end def test_unschedule_fixed_fee_quantity_updates_required_params @@ -139,6 +424,36 @@ def test_unschedule_fixed_fee_quantity_updates_required_params assert_pattern do response => Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse end + + assert_pattern do + response => { + id: String, + active_plan_phase_order: Integer | nil, + adjustment_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval]), + auto_collection: Orb::BooleanModel | nil, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time | nil, + current_billing_period_start_date: Time | nil, + customer: Orb::Models::Customer, + default_invoice_memo: String | nil, + discount_intervals: ^(Orb::ArrayOf[union: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval]), + end_date: Time | nil, + fixed_fee_quantity_schedule: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::FixedFeeQuantitySchedule]), + invoicing_threshold: String | nil, + maximum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval]), + metadata: ^(Orb::HashOf[String]), + minimum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval]), + net_terms: Integer, + plan: Orb::Models::Plan, + price_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval]), + redeemed_coupon: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::RedeemedCoupon | nil, + start_date: Time, + status: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status, + trial_info: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo + } + end end def test_unschedule_pending_plan_changes @@ -147,6 +462,36 @@ def test_unschedule_pending_plan_changes assert_pattern do response => Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse end + + assert_pattern do + response => { + id: String, + active_plan_phase_order: Integer | nil, + adjustment_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval]), + auto_collection: Orb::BooleanModel | nil, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time | nil, + current_billing_period_start_date: Time | nil, + customer: Orb::Models::Customer, + default_invoice_memo: String | nil, + discount_intervals: ^(Orb::ArrayOf[union: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval]), + end_date: Time | nil, + fixed_fee_quantity_schedule: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::FixedFeeQuantitySchedule]), + invoicing_threshold: String | nil, + maximum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MaximumInterval]), + metadata: ^(Orb::HashOf[String]), + minimum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MinimumInterval]), + net_terms: Integer, + plan: Orb::Models::Plan, + price_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval]), + redeemed_coupon: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::RedeemedCoupon | nil, + start_date: Time, + status: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status, + trial_info: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo + } + end end def test_update_fixed_fee_quantity_required_params @@ -159,6 +504,36 @@ def test_update_fixed_fee_quantity_required_params assert_pattern do response => Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse end + + assert_pattern do + response => { + id: String, + active_plan_phase_order: Integer | nil, + adjustment_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval]), + auto_collection: Orb::BooleanModel | nil, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time | nil, + current_billing_period_start_date: Time | nil, + customer: Orb::Models::Customer, + default_invoice_memo: String | nil, + discount_intervals: ^(Orb::ArrayOf[union: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval]), + end_date: Time | nil, + fixed_fee_quantity_schedule: ^(Orb::ArrayOf[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::FixedFeeQuantitySchedule]), + invoicing_threshold: String | nil, + maximum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MaximumInterval]), + metadata: ^(Orb::HashOf[String]), + minimum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MinimumInterval]), + net_terms: Integer, + plan: Orb::Models::Plan, + price_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval]), + redeemed_coupon: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::RedeemedCoupon | nil, + start_date: Time, + status: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status, + trial_info: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo + } + end end def test_update_trial_required_params @@ -167,5 +542,35 @@ def test_update_trial_required_params assert_pattern do response => Orb::Models::SubscriptionUpdateTrialResponse end + + assert_pattern do + response => { + id: String, + active_plan_phase_order: Integer | nil, + adjustment_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval]), + auto_collection: Orb::BooleanModel | nil, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionUpdateTrialResponse::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time | nil, + current_billing_period_start_date: Time | nil, + customer: Orb::Models::Customer, + default_invoice_memo: String | nil, + discount_intervals: ^(Orb::ArrayOf[union: Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval]), + end_date: Time | nil, + fixed_fee_quantity_schedule: ^(Orb::ArrayOf[Orb::Models::SubscriptionUpdateTrialResponse::FixedFeeQuantitySchedule]), + invoicing_threshold: String | nil, + maximum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUpdateTrialResponse::MaximumInterval]), + metadata: ^(Orb::HashOf[String]), + minimum_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUpdateTrialResponse::MinimumInterval]), + net_terms: Integer, + plan: Orb::Models::Plan, + price_intervals: ^(Orb::ArrayOf[Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval]), + redeemed_coupon: Orb::Models::SubscriptionUpdateTrialResponse::RedeemedCoupon | nil, + start_date: Time, + status: Orb::Models::SubscriptionUpdateTrialResponse::Status, + trial_info: Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo + } + end end end diff --git a/test/orb/resources/top_level_test.rb b/test/orb/resources/top_level_test.rb index 2a7727c0..da025c68 100644 --- a/test/orb/resources/top_level_test.rb +++ b/test/orb/resources/top_level_test.rb @@ -16,5 +16,11 @@ def test_ping assert_pattern do response => Orb::Models::TopLevelPingResponse end + + assert_pattern do + response => { + response: String + } + end end end